feat: creating and deleting pull requests reviews and comments (#12)

Author: jpb06

README.md

@@ -162,16 +162,27 @@ const reactRepo: RepoArgs = {
 };
 const pull = repo.pull(39);
 
-const [details, reviews, comments] = await Effect.runPromise(
+const [details, comments, reviews, createdReview, deletedReview] = await Effect.runPromise(
   pipe(
     Effect.all(
       [
         // Pull request details
         pull.details(),
-        // Pull request #39 reviews
-        pull.reviews(),
         // All the comments made on the pull request #39
         pull.comments(),
+        // Pull request #39 reviews
+        pull.reviews.get(),
+        // Create a review
+        pull.reviews.create({
+          event: 'REQUEST_CHANGES',
+          body: 'I think some points need to be adressed',
+          comments: [{
+            path: './src/cool.ts',
+            body: "Shouldn't this file be renamed",
+          }],
+        }),
+        // Delete review #2
+        pull.reviews.delete(2);
       ],
       { concurrency: 'unbounded' }
     ),
@@ -180,7 +191,7 @@ const [details, reviews, comments] = await Effect.runPromise(
 );
 ```
 
-### 🔶 Pull request reviews
+### 🔶 Pull request comments
 
 ```typescript
 import {
@@ -197,13 +208,23 @@ const reactRepo: RepoArgs = {
 const pull = repo.pull(39);
 const review = pull.review(2593339077);
 
-const comments = await Effect.runPromise(
-  pipe(
-    // Review #2593339077 comments
-    review.comments(),
-    Effect.provide(Layer.mergeAll(OctokitLayerLive, LoggerConsoleLive))
-  )
-);
+const [details, comments, reviews, createdReview, deletedReview] =
+  await Effect.runPromise(
+    pipe(
+      Effect.all([
+        // Create a comment in review #2593339077 on pull request #39
+        review.comments.create({
+          path: './src',
+          body: 'cool',
+          commitId: 'ff',
+        }),
+        // Get review #2593339077 comments
+        review.comments.get(),
+        // Delete comment #1 in review #2593339077
+        review.comments.delete(1),
+      ])
+    )
+  );
 ```
 
 ### 🔶 Parallelism and resilience

sonar-project.properties

@@ -5,5 +5,5 @@ sonar.projectName=effect-octokit-layer
 sonar.sources=.
 
 sonar.javascript.lcov.reportPaths=./coverage/lcov.info
-sonar.exclusions=src/tests/**,src/**/*.test.ts,src/index.ts,src/test.ts,src/**/*.type.ts,src/types/**,src/layer/octokit.layer.ts,src/layer/effects/tap-layer.effect.ts
+sonar.exclusions=src/tests/**,src/**/*.test.ts,src/index.ts,src/test.ts,src/**/*.type.ts,src/layer/api/**,src/types/**,src/layer/octokit.layer.ts,src/layer/effects/tap-layer.effect.ts
 sonar.verbose=false

src/index.ts

@@ -1,7 +1,7 @@
 import { Logger, LoggerConsoleLive } from '@dependencies/logger';
 
+import type { RepoArgs } from './layer/api/repos/types/repo-args.type.js';
 import { OctokitLayerLive } from './layer/github/octokit.layer-live.js';
-import type { RepoArgs } from './layer/octokit.layer.js';
 import { OctokitLayer } from './layer/octokit.layer.js';
 
 export { OctokitLayer, OctokitLayerLive };

src/layer/api/index.ts

@@ -0,0 +1,4 @@
+export * from './orgs.api.js';
+export * from './users.api.js';
+export * from './repos/repos-issues.api.js';
+export * from './repos/pull-requests/pull-requests.js';

src/layer/api/orgs.api.ts

@@ -0,0 +1,11 @@
+import { defaultConcurrency } from '@constants';
+
+import { tapLayer } from '../effects/tap-layer.effect.js';
+import { OctokitLayerContext as Context } from '../octokit.context.js';
+
+export const orgsApi = (owner: string) => ({
+  repos: (concurrency = defaultConcurrency) =>
+    tapLayer(Context, ({ getRepositories }) =>
+      getRepositories({ target: owner, type: 'org', concurrency }),
+    ),
+});

src/layer/api/repos/pull-requests/pull-requests-reviews-comments.ts

@@ -0,0 +1,48 @@
+import { defaultConcurrency } from '@constants';
+import type { PullRequestCommentCreationArgs } from '@implementation';
+
+import { tapLayer } from '../../../effects/tap-layer.effect.js';
+import { OctokitLayerContext as Context } from '../../../octokit.context.js';
+import type { RepoArgs } from '../types/repo-args.type.js';
+
+type PullRequestsReviewsCommentsApi = RepoArgs & {
+  pullNumber: number;
+  reviewId: number;
+};
+
+export const pullRequestsReviewsCommentsApi = ({
+  owner,
+  name,
+  pullNumber,
+  reviewId,
+}: PullRequestsReviewsCommentsApi) => ({
+  create: (
+    args: Pick<PullRequestCommentCreationArgs, 'body' | 'commitId' | 'path'>,
+  ) =>
+    tapLayer(Context, ({ createPullRequestComment }) =>
+      createPullRequestComment({
+        owner,
+        repo: name,
+        pullNumber,
+        ...args,
+      }),
+    ),
+  get: (concurrency = defaultConcurrency) =>
+    tapLayer(Context, ({ getPullRequestReviewComments }) =>
+      getPullRequestReviewComments({
+        owner,
+        repo: name,
+        pullNumber,
+        reviewId,
+        concurrency,
+      }),
+    ),
+  delete: (commentId: number) =>
+    tapLayer(Context, ({ deletePullRequestComment }) =>
+      deletePullRequestComment({
+        owner,
+        repo: name,
+        commentId,
+      }),
+    ),
+});

src/layer/api/repos/pull-requests/pull-requests-reviews.ts

@@ -0,0 +1,57 @@
+import { defaultConcurrency } from '@constants';
+import type { PullRequestReviewCreationArgs } from '@implementation';
+
+import { tapLayer } from '../../../effects/tap-layer.effect.js';
+import { OctokitLayerContext as Context } from '../../../octokit.context.js';
+import type { RepoArgs } from '../types/repo-args.type.js';
+import { pullRequestsReviewsCommentsApi } from './pull-requests-reviews-comments.js';
+
+type PullRequestsReviewsApiArgs = RepoArgs & {
+  pullNumber: number;
+};
+
+export const pullRequestsReviewsApi = ({
+  owner,
+  name,
+  pullNumber,
+}: PullRequestsReviewsApiArgs) => ({
+  review: (reviewId: number) => ({
+    comments: pullRequestsReviewsCommentsApi({
+      owner,
+      name,
+      pullNumber,
+      reviewId,
+    }),
+  }),
+  reviews: {
+    create: (
+      args: Pick<PullRequestReviewCreationArgs, 'body' | 'comments' | 'event'>,
+    ) =>
+      tapLayer(Context, ({ createPullRequestReview }) =>
+        createPullRequestReview({
+          owner,
+          repo: name,
+          pullNumber,
+          ...args,
+        }),
+      ),
+    get: (concurrency = defaultConcurrency) =>
+      tapLayer(Context, ({ getPullRequestReviews }) =>
+        getPullRequestReviews({
+          owner,
+          repo: name,
+          pullNumber,
+          concurrency,
+        }),
+      ),
+    delete: (reviewId: number) =>
+      tapLayer(Context, ({ deletePullRequestReview }) =>
+        deletePullRequestReview({
+          owner,
+          repo: name,
+          pullNumber,
+          reviewId,
+        }),
+      ),
+  },
+});

src/layer/api/repos/pull-requests/pull-requests.ts

@@ -0,0 +1,29 @@
+import { defaultConcurrency } from '@constants';
+
+import { tapLayer } from '../../../effects/tap-layer.effect.js';
+import { OctokitLayerContext as Context } from '../../../octokit.context.js';
+import type { RepoArgs } from '../types/repo-args.type.js';
+import { pullRequestsReviewsApi } from './pull-requests-reviews.js';
+
+export const repoPullRequestsApi = ({ owner, name }: RepoArgs) => ({
+  pulls: (concurrency = defaultConcurrency) =>
+    tapLayer(Context, ({ getRepoPullRequests }) =>
+      getRepoPullRequests({ owner, repo: name, concurrency }),
+    ),
+  pull: (number: number) => ({
+    details: () =>
+      tapLayer(Context, ({ getPullRequest }) =>
+        getPullRequest({ owner, repo: name, number }),
+      ),
+    comments: (concurrency = defaultConcurrency) =>
+      tapLayer(Context, ({ getPullRequestComments }) =>
+        getPullRequestComments({
+          owner,
+          repo: name,
+          pullNumber: number,
+          concurrency,
+        }),
+      ),
+    ...pullRequestsReviewsApi({ owner, name, pullNumber: number }),
+  }),
+});

src/layer/api/repos/repos-issues.api.ts

@@ -0,0 +1,16 @@
+import { defaultConcurrency } from '@constants';
+
+import { tapLayer } from '../../effects/tap-layer.effect.js';
+import { OctokitLayerContext as Context } from '../../octokit.context.js';
+import type { RepoArgs } from './types/repo-args.type.js';
+
+export const repoIssuesApi = ({ owner, name }: RepoArgs) => ({
+  issues: (concurrency = defaultConcurrency) =>
+    tapLayer(Context, ({ getRepoIssues }) =>
+      getRepoIssues({ owner, repo: name, concurrency }),
+    ),
+  issue: (number: number) =>
+    tapLayer(Context, ({ getIssue }) =>
+      getIssue({ owner, repo: name, number }),
+    ),
+});

src/layer/api/repos/types/repo-args.type.ts

@@ -0,0 +1,4 @@
+export interface RepoArgs {
+  owner: string;
+  name: string;
+}