npm-update-package 0.31.2 → 0.31.3

package/src/github/branch/finder/index.ts

@@ -0,0 +1 @@
+export * from './BranchFinder'

package/src/github/branch/index.ts

@@ -0,0 +1 @@
+export * from './finder'

package/src/github/createGitHub.test.ts

@@ -0,0 +1,16 @@
+import { GitRepository } from '../git'
+import { createGitHub } from './createGitHub'
+import { GitHub } from './GitHub'
+
+describe('createGitHub', () => {
+  it('returns new GitHub instance', () => {
+    const repository = GitRepository.of('https://github.com/npm-update-package/npm-update-package.git')
+    const token = 'token'
+    const github = createGitHub({
+      repository,
+      token
+    })
+
+    expect(github).toBeInstanceOf(GitHub)
+  })
+})

package/src/github/createGitHub.ts

@@ -0,0 +1,17 @@
+import type { GitRepository } from '../git'
+import { createOctokit } from './createOctokit'
+import { GitHub } from './GitHub'
+
+export const createGitHub = ({
+  repository,
+  token
+}: {
+  repository: GitRepository
+  token: string
+}): GitHub => {
+  const octokit = createOctokit({
+    repository,
+    token
+  })
+  return new GitHub(octokit)
+}

package/src/github/createOctokit.test.ts

@@ -0,0 +1,27 @@
+import { Octokit } from '@octokit/rest'
+import { GitRepository } from '../git'
+import { createOctokit } from './createOctokit'
+
+describe('createOctokit', () => {
+  const token = 'token'
+
+  it('returns new Octokit instance for GitHub.com if repository is GitHub.com', () => {
+    const repository = GitRepository.of('https://github.com/npm-update-package/npm-update-package.git')
+    const octokit = createOctokit({
+      repository,
+      token
+    })
+
+    expect(octokit).toBeInstanceOf(Octokit)
+  })
+
+  it('returns new Octokit instance for GitHub Enterprise if repository is not GitHub.com', () => {
+    const repository = GitRepository.of('https://git.example.com/npm-update-package/npm-update-package.git')
+    const octokit = createOctokit({
+      repository,
+      token
+    })
+
+    expect(octokit).toBeInstanceOf(Octokit)
+  })
+})

package/src/github/createOctokit.ts

@@ -0,0 +1,27 @@
+import { Octokit } from '@octokit/rest'
+import pkg from '../../package.json'
+import type { GitRepository } from '../git'
+
+export const createOctokit = ({
+  repository,
+  token
+}: {
+  repository: GitRepository
+  token: string
+}): Octokit => {
+  const auth = `token ${token}`
+  const userAgent = `${pkg.name}/${pkg.version}`
+
+  if (repository.isGitHubDotCom) {
+    return new Octokit({
+      auth,
+      userAgent
+    })
+  } else {
+    return new Octokit({
+      auth,
+      userAgent,
+      baseUrl: repository.apiEndPoint
+    })
+  }
+}

package/src/github/errors/NotFoundError.ts

@@ -0,0 +1,11 @@
+import { RequestError } from '@octokit/request-error'
+import { StatusCodes } from 'http-status-codes'
+
+export interface NotFoundError extends RequestError {
+  status: StatusCodes.NOT_FOUND
+}
+
+// TODO: Add test
+export const isNotFoundError = (value: unknown): value is NotFoundError => {
+  return value instanceof RequestError && value.status === StatusCodes.NOT_FOUND
+}

package/src/github/errors/index.ts

@@ -0,0 +1 @@
+export * from './NotFoundError'

package/src/github/index.ts

@@ -0,0 +1,5 @@
+export * from './branch'
+export * from './createGitHub'
+export * from './errors'
+export * from './label'
+export * from './pull-request'

package/src/github/label/creator/LabelCreator.ts

@@ -0,0 +1,71 @@
+import type { GitRepository } from '../../../git'
+import type { Logger } from '../../../logger'
+import { isNotFoundError } from '../../errors'
+import type {
+  GitHub,
+  Label
+} from '../../GitHub'
+
+// TODO: Add test
+export class LabelCreator {
+  private readonly github: GitHub
+  private readonly gitRepo: GitRepository
+  private readonly logger: Logger
+
+  constructor ({
+    github,
+    gitRepo,
+    logger
+  }: {
+    github: GitHub
+    gitRepo: GitRepository
+    logger: Logger
+  }) {
+    this.github = github
+    this.gitRepo = gitRepo
+    this.logger = logger
+  }
+
+  async create ({
+    name,
+    description,
+    color
+  }: {
+    name: string
+    description?: string
+    color?: string
+  }): Promise<void> {
+    const label = await this.fetchLabel(name)
+
+    if (label !== undefined) {
+      this.logger.info(`Skip creating ${name} label because it already exists.`)
+      return
+    }
+
+    await this.github.createLabel({
+      owner: this.gitRepo.owner,
+      repo: this.gitRepo.name,
+      name,
+      description,
+      color
+    })
+    this.logger.info(`${name} label has created.`)
+  }
+
+  private async fetchLabel (name: string): Promise<Label | undefined> {
+    try {
+      return await this.github.fetchLabel({
+        owner: this.gitRepo.owner,
+        repo: this.gitRepo.name,
+        name
+      })
+    } catch (e) {
+      if (isNotFoundError(e)) {
+        this.logger.warn(e)
+        return undefined
+      } else {
+        throw e
+      }
+    }
+  }
+}

package/src/github/label/creator/index.ts

@@ -0,0 +1 @@
+export * from './LabelCreator'

package/src/github/label/index.ts

@@ -0,0 +1 @@
+export * from './creator'

package/src/github/pull-request/closer/PullRequestCloser.test.ts

@@ -0,0 +1,53 @@
+import type {
+  GitHub,
+  PullRequest
+} from '../../GitHub'
+import { PullRequestCloser } from './PullRequestCloser'
+
+describe('PullRequestCloser', () => {
+  describe('close', () => {
+    const githubClosePullRequestMock = jest.fn()
+    const githubDeleteBranchMock = jest.fn()
+
+    const github = {
+      closePullRequest: githubClosePullRequestMock,
+      deleteBranch: githubDeleteBranchMock
+    } as unknown as GitHub
+
+    afterEach(() => {
+      githubClosePullRequestMock.mockReset()
+      githubDeleteBranchMock.mockReset()
+    })
+
+    it('closes pull request', async () => {
+      const pullRequest = {
+        number: 1,
+        head: {
+          ref: 'new-topic'
+        },
+        base: {
+          repo: {
+            name: 'npm-update-package',
+            owner: {
+              login: 'npm-update-package'
+            }
+          }
+        }
+      } as unknown as PullRequest
+
+      const pullRequestCreator = new PullRequestCloser(github)
+      await pullRequestCreator.close(pullRequest)
+
+      expect(githubClosePullRequestMock).toBeCalledWith({
+        owner: pullRequest.base.repo.owner.login,
+        repo: pullRequest.base.repo.name,
+        pullNumber: pullRequest.number
+      })
+      expect(githubDeleteBranchMock).toBeCalledWith({
+        owner: pullRequest.base.repo.owner.login,
+        repo: pullRequest.base.repo.name,
+        branch: pullRequest.head.ref
+      })
+    })
+  })
+})

package/src/github/pull-request/closer/PullRequestCloser.ts

@@ -0,0 +1,21 @@
+import type {
+  GitHub,
+  PullRequest
+} from '../../GitHub'
+
+export class PullRequestCloser {
+  constructor (private readonly github: GitHub) {}
+
+  async close (pullRequest: PullRequest): Promise<void> {
+    await this.github.closePullRequest({
+      owner: pullRequest.base.repo.owner.login,
+      repo: pullRequest.base.repo.name,
+      pullNumber: pullRequest.number
+    })
+    await this.github.deleteBranch({
+      owner: pullRequest.base.repo.owner.login,
+      repo: pullRequest.base.repo.name,
+      branch: pullRequest.head.ref
+    })
+  }
+}

package/src/github/pull-request/closer/index.ts

@@ -0,0 +1 @@
+export * from './PullRequestCloser'

package/src/github/pull-request/creator/PullRequestCreator.test.ts

@@ -0,0 +1,98 @@
+import type { OutdatedPackage } from '../../../core'
+import type { GitRepository } from '../../../git'
+import {
+  createLogger,
+  LogLevel
+} from '../../../logger'
+import type {
+  GitHub,
+  Repository as GitHubRepository
+} from '../../GitHub'
+import * as createPullRequestBodyModule from './createPullRequestBody'
+import { PullRequestCreator } from './PullRequestCreator'
+import type { PullRequestTitleCreator } from './PullRequestTitleCreator'
+
+describe('PullRequestCreator', () => {
+  describe('create', () => {
+    const pullRequestTitleCreatorCreateMock = jest.fn()
+    const githubCreatePullRequestMock = jest.fn()
+    const githubAddLabelsMock = jest.fn()
+    const githubRequestReviewersMock = jest.fn()
+    const createPullRequestBodySpy = jest.spyOn(createPullRequestBodyModule, 'createPullRequestBody')
+
+    const github = {
+      createPullRequest: githubCreatePullRequestMock,
+      addLabels: githubAddLabelsMock,
+      requestReviewers: githubRequestReviewersMock
+    } as unknown as GitHub
+    const gitRepo = {
+      owner: 'repository owner',
+      name: 'repository name'
+    } as unknown as GitRepository
+    const githubRepo = {
+      default_branch: 'master'
+    } as unknown as GitHubRepository
+    const pullRequestTitleCreator = {
+      create: pullRequestTitleCreatorCreateMock
+    } as unknown as PullRequestTitleCreator
+    const logger = createLogger(LogLevel.Off)
+    const outdatedPackage = {} as unknown as OutdatedPackage
+    const branchName = 'branch name'
+
+    afterEach(() => {
+      pullRequestTitleCreatorCreateMock.mockReset()
+      githubCreatePullRequestMock.mockReset()
+      githubAddLabelsMock.mockReset()
+      githubRequestReviewersMock.mockReset()
+      createPullRequestBodySpy.mockReset()
+    })
+
+    it('creates pull request', async () => {
+      const title = 'pull request title'
+      pullRequestTitleCreatorCreateMock.mockReturnValue(title)
+      const body = 'pull request body'
+      createPullRequestBodySpy.mockReturnValue(body)
+      const pullRequest = {
+        number: 1
+      }
+      githubCreatePullRequestMock.mockResolvedValue(pullRequest)
+
+      const reviewers = ['npm-update-package']
+      const pullRequestCreator = new PullRequestCreator({
+        github,
+        gitRepo,
+        githubRepo,
+        pullRequestTitleCreator,
+        logger,
+        reviewers
+      })
+      await pullRequestCreator.create({
+        outdatedPackage,
+        branchName
+      })
+
+      expect(pullRequestTitleCreatorCreateMock).toBeCalledWith(outdatedPackage)
+      expect(createPullRequestBodySpy).toBeCalledWith(outdatedPackage)
+      expect(githubCreatePullRequestMock).toBeCalledWith({
+        owner: gitRepo.owner,
+        repo: gitRepo.name,
+        baseBranch: githubRepo.default_branch,
+        headBranch: branchName,
+        title,
+        body
+      })
+      expect(githubAddLabelsMock).toBeCalledWith({
+        owner: gitRepo.owner,
+        repo: gitRepo.name,
+        issueNumber: pullRequest.number,
+        labels: ['npm-update-package']
+      })
+      expect(githubRequestReviewersMock).toBeCalledWith({
+        owner: gitRepo.owner,
+        repo: gitRepo.name,
+        pullNumber: pullRequest.number,
+        reviewers
+      })
+    })
+  })
+})

package/src/github/pull-request/creator/PullRequestCreator.ts

@@ -0,0 +1,84 @@
+import type { OutdatedPackage } from '../../../core'
+import type { GitRepository } from '../../../git'
+import type { Logger } from '../../../logger'
+import type {
+  CreatedPullRequest,
+  GitHub,
+  Repository as GitHubRepository
+} from '../../GitHub'
+import { createPullRequestBody } from './createPullRequestBody'
+import type { PullRequestTitleCreator } from './PullRequestTitleCreator'
+
+export class PullRequestCreator {
+  private readonly github: GitHub
+  private readonly gitRepo: GitRepository
+  private readonly githubRepo: GitHubRepository
+  private readonly pullRequestTitleCreator: PullRequestTitleCreator
+  private readonly logger: Logger
+  private readonly reviewers: string[] | undefined
+
+  constructor ({
+    github,
+    gitRepo,
+    githubRepo,
+    pullRequestTitleCreator,
+    logger,
+    reviewers
+  }: {
+    github: GitHub
+    gitRepo: GitRepository
+    githubRepo: GitHubRepository
+    pullRequestTitleCreator: PullRequestTitleCreator
+    logger: Logger
+    reviewers?: string[]
+  }) {
+    this.github = github
+    this.gitRepo = gitRepo
+    this.githubRepo = githubRepo
+    this.pullRequestTitleCreator = pullRequestTitleCreator
+    this.logger = logger
+    this.reviewers = reviewers
+  }
+
+  async create ({
+    outdatedPackage,
+    branchName
+  }: {
+    outdatedPackage: OutdatedPackage
+    branchName: string
+  }): Promise<CreatedPullRequest> {
+    const title = this.pullRequestTitleCreator.create(outdatedPackage)
+    this.logger.debug(`title=${title}`)
+
+    const body = createPullRequestBody(outdatedPackage)
+    this.logger.debug(`body=${body}`)
+
+    const pullRequest = await this.github.createPullRequest({
+      owner: this.gitRepo.owner,
+      repo: this.gitRepo.name,
+      baseBranch: this.githubRepo.default_branch,
+      headBranch: branchName,
+      title,
+      body
+    })
+    this.logger.debug(`pullRequest=${JSON.stringify(pullRequest)}`)
+
+    await this.github.addLabels({
+      owner: this.gitRepo.owner,
+      repo: this.gitRepo.name,
+      issueNumber: pullRequest.number,
+      labels: ['npm-update-package']
+    })
+
+    if (this.reviewers !== undefined) {
+      await this.github.requestReviewers({
+        owner: this.gitRepo.owner,
+        repo: this.gitRepo.name,
+        pullNumber: pullRequest.number,
+        reviewers: this.reviewers
+      })
+    }
+
+    return pullRequest
+  }
+}

package/src/github/pull-request/creator/PullRequestTitleCreator.test.ts

@@ -0,0 +1,17 @@
+import { SemVer } from '../../../semver'
+import { PullRequestTitleCreator } from './PullRequestTitleCreator'
+
+describe('PullRequestTitleCreator', () => {
+  describe('create', () => {
+    it('returns pull request title', () => {
+      const pullRequestTitleCreator = new PullRequestTitleCreator('chore(deps): {{level}} update {{{packageName}}} from {{currentVersion}} to v{{newVersion}}')
+      const actual = pullRequestTitleCreator.create({
+        name: '@npm-update-package/example',
+        currentVersion: SemVer.of('1.0.0'),
+        newVersion: SemVer.of('2.0.0'),
+        level: 'major'
+      })
+      expect(actual).toBe('chore(deps): major update @npm-update-package/example from 1.0.0 to v2.0.0')
+    })
+  })
+})

package/src/github/pull-request/creator/PullRequestTitleCreator.ts

@@ -0,0 +1,19 @@
+import { render } from 'mustache'
+import type { OutdatedPackage } from '../../../core'
+
+export class PullRequestTitleCreator {
+  constructor (private readonly template: string) {}
+
+  create (outdatedPackage: OutdatedPackage): string {
+    const packageName = outdatedPackage.name
+    const currentVersion = outdatedPackage.currentVersion.version
+    const newVersion = outdatedPackage.newVersion.version
+    const level = outdatedPackage.level
+    return render(this.template, {
+      packageName,
+      currentVersion,
+      newVersion,
+      level
+    })
+  }
+}

package/src/github/pull-request/creator/createPullRequestBody.test.ts

@@ -0,0 +1,47 @@
+
+import pkg from '../../../../package.json'
+import { SemVer } from '../../../semver'
+import { createPullRequestBody } from './createPullRequestBody'
+
+describe('createPullRequestBody', () => {
+  it('returns pull request body', () => {
+    const actual = createPullRequestBody({
+      name: '@npm-update-package/example',
+      currentVersion: SemVer.of('1.0.0'),
+      newVersion: SemVer.of('2.0.0'),
+      level: 'major'
+    })
+    expect(actual).toBe(`This PR updates these packages:
+
+|Package|Level|Current version|New version|
+|---|---|---|---|
+|[@npm-update-package/example](https://www.npmjs.com/package/@npm-update-package/example)|major|\`1.0.0\`|\`2.0.0\`|
+
+<details>
+<summary>Metadata</summary>
+
+**Don't remove or edit this section because it will be used by npm-update-package.**
+
+<div id="npm-update-package-metadata">
+
+\`\`\`json
+{
+  "version": "${pkg.version}",
+  "packages": [
+    {
+      "name": "@npm-update-package/example",
+      "currentVersion": "1.0.0",
+      "newVersion": "2.0.0",
+      "level": "major"
+    }
+  ]
+}
+\`\`\`
+
+</div>
+</details>
+
+---
+This PR has been generated by [${pkg.name}](${pkg.homepage}) v${pkg.version}`)
+  })
+})

package/src/github/pull-request/creator/createPullRequestBody.ts

@@ -0,0 +1,35 @@
+
+import pkg from '../../../../package.json'
+import type { OutdatedPackage } from '../../../core'
+import { toJSON } from '../../../json'
+import { createPullRequestMetadata } from '../metadata'
+
+export const createPullRequestBody = (outdatedPackage: OutdatedPackage): string => {
+  const currentVersion = outdatedPackage.currentVersion.version
+  const newVersion = outdatedPackage.newVersion.version
+  const packageName = outdatedPackage.name
+  const level = outdatedPackage.level
+  const metadata = toJSON(createPullRequestMetadata([outdatedPackage]), { pretty: true })
+  return `This PR updates these packages:
+
+|Package|Level|Current version|New version|
+|---|---|---|---|
+|[${packageName}](https://www.npmjs.com/package/${packageName})|${level}|\`${currentVersion}\`|\`${newVersion}\`|
+
+<details>
+<summary>Metadata</summary>
+
+**Don't remove or edit this section because it will be used by npm-update-package.**
+
+<div id="npm-update-package-metadata">
+
+\`\`\`json
+${metadata}
+\`\`\`
+
+</div>
+</details>
+
+---
+This PR has been generated by [${pkg.name}](${pkg.homepage}) v${pkg.version}`
+}

package/src/github/pull-request/creator/index.ts

@@ -0,0 +1,2 @@
+export * from './PullRequestCreator'
+export * from './PullRequestTitleCreator'

package/src/github/pull-request/finder/PullRequestFinder.ts

@@ -0,0 +1,27 @@
+import type { PullRequest } from '../../GitHub'
+import { extractPullRequestMetadata } from '../metadata'
+import { isPullRequestByNpmUpdatePackage } from './isPullRequestByNpmUpdatePackage'
+
+// TODO: Add test
+export class PullRequestFinder {
+  constructor (private readonly pullRequests: PullRequest[]) {}
+
+  findByPackageName (packageName: string): PullRequest[] {
+    return this.pullRequests
+      .filter(isPullRequestByNpmUpdatePackage)
+      .filter(({ body }) => {
+        if (body === null) {
+          return false
+        }
+
+        const metadata = extractPullRequestMetadata(body)
+
+        if (metadata === undefined) {
+          return false
+        }
+
+        const { packages } = metadata
+        return packages.some(({ name }) => name === packageName)
+      })
+  }
+}

package/src/github/pull-request/finder/index.ts

@@ -0,0 +1 @@
+export * from './PullRequestFinder'

package/src/github/pull-request/finder/isPullRequestByNpmUpdatePackage.test.ts

@@ -0,0 +1,24 @@
+import type { PullRequest } from '../../GitHub'
+import { isPullRequestByNpmUpdatePackage } from './isPullRequestByNpmUpdatePackage'
+
+describe('isPullRequestByNpmUpdatePackage', () => {
+  it('returns true if pull request has label `npm-update-package`', () => {
+    const pullRequest = {
+      labels: [
+        {
+          name: 'npm-update-package'
+        }
+      ]
+    } as unknown as PullRequest
+
+    expect(isPullRequestByNpmUpdatePackage(pullRequest)).toBe(true)
+  })
+
+  it('returns false if pull request does not have label `npm-update-package`', () => {
+    const pullRequest = {
+      labels: []
+    } as unknown as PullRequest
+
+    expect(isPullRequestByNpmUpdatePackage(pullRequest)).toBe(false)
+  })
+})

package/src/github/pull-request/finder/isPullRequestByNpmUpdatePackage.ts

@@ -0,0 +1,5 @@
+import type { PullRequest } from '../../GitHub'
+
+export const isPullRequestByNpmUpdatePackage = (pullRequest: PullRequest): boolean => {
+  return pullRequest.labels.some(({ name }) => name === 'npm-update-package')
+}

package/src/github/pull-request/index.ts

@@ -0,0 +1,3 @@
+export * from './closer'
+export * from './creator'
+export * from './finder'

package/src/github/pull-request/metadata/PullRequestMetadata.ts

@@ -0,0 +1,22 @@
+import {
+  array,
+  literal,
+  string,
+  type,
+  union,
+  type TypeOf
+} from 'io-ts'
+import { SemVerLevel } from '../../../semver'
+
+const PullRequestMetadata = type({
+  version: string,
+  packages: array(type({
+    name: string,
+    currentVersion: string,
+    newVersion: string,
+    level: union([literal(SemVerLevel.Major), literal(SemVerLevel.Minor), literal(SemVerLevel.Patch)])
+  }))
+})
+// eslint-disable-next-line @typescript-eslint/no-redeclare
+export type PullRequestMetadata = TypeOf<typeof PullRequestMetadata>
+export const isPullRequestMetadata = PullRequestMetadata.is