Revert "Removes FRAMNA_DOCS_BASE_URL"

This reverts commit 3cef0b2.

Author: simonbs

.env.example

@@ -1,3 +1,4 @@
+FRAMNA_DOCS_BASE_URL=http://localhost:3000
 FRAMNA_DOCS_TITLE=Framna Docs
 FRAMNA_DOCS_DESCRIPTION=Documentation for Framna's APIs
 FRAMNA_DOCS_HELP_URL=https://github.com/shapehq/framna-docs/wiki

src/composition.ts

@@ -195,6 +195,7 @@ export const gitHubHookHandler = new GitHubHookHandler({
     eventHandler: new PostCommentPullRequestEventHandler({
       pullRequestCommenter: new PullRequestCommenter({
         siteName: env.getOrThrow("FRAMNA_DOCS_TITLE"),
+        domain: env.getOrThrow("FRAMNA_DOCS_BASE_URL"),
         repositoryNameSuffix: env.getOrThrow("REPOSITORY_NAME_SUFFIX"),
         projectConfigurationFilename: env.getOrThrow("FRAMNA_DOCS_PROJECT_CONFIGURATION_FILENAME"),
         gitHubAppId: env.getOrThrow("GITHUB_APP_ID"),

src/features/hooks/data/GitHubHookHandler.ts

@@ -10,7 +10,6 @@ interface GitHubHookHandlerConfig {
 export default class GitHubHookHandler {
   private readonly webhooks: Webhooks
   private readonly pullRequestEventHandler: IPullRequestEventHandler
-  private hostURL: string | undefined
 
   constructor(config: GitHubHookHandlerConfig) {
     this.webhooks = new Webhooks({ secret: config.secret })
@@ -19,8 +18,6 @@ export default class GitHubHookHandler {
   }
 
   async handle(req: NextRequest): Promise<void> {
-    const url = new URL(req.url)
-    this.hostURL = `${url.protocol}//${url.hostname}${url.port ? ":" + url.port : ""}`
     await this.webhooks.verifyAndReceive({
       id: req.headers.get("X-GitHub-Delivery") as string,
       /* eslint-disable-next-line @typescript-eslint/no-explicit-any */
@@ -38,11 +35,7 @@ export default class GitHubHookHandler {
       if (!payload.installation) {
         throw new Error("Payload does not contain information about the app installation.")
       }
-      if (!this.hostURL) {
-        throw new Error("hostURL was not stored as part of the webhook request.")
-      }
       await this.pullRequestEventHandler.pullRequestOpened({
-        hostURL: this.hostURL,
         appInstallationId: payload.installation.id,
         repositoryOwner: payload.repository.owner.login,
         repositoryName: payload.repository.name,
@@ -54,11 +47,7 @@ export default class GitHubHookHandler {
       if (!payload.installation) {
         throw new Error("Payload does not contain information about the app installation.")
       }
-      if (!this.hostURL) {
-        throw new Error("hostURL was not stored as part of the webhook request.")
-      }
       await this.pullRequestEventHandler.pullRequestReopened({
-        hostURL: this.hostURL,
         appInstallationId: payload.installation.id,
         repositoryOwner: payload.repository.owner.login,
         repositoryName: payload.repository.name,
@@ -70,11 +59,7 @@ export default class GitHubHookHandler {
       if (!payload.installation) {
         throw new Error("Payload does not contain information about the app installation.")
       }
-      if (!this.hostURL) {
-        throw new Error("hostURL was not stored as part of the webhook request.")
-      }
       await this.pullRequestEventHandler.pullRequestSynchronized({
-        hostURL: this.hostURL,
         appInstallationId: payload.installation.id,
         repositoryOwner: payload.repository.owner.login,
         repositoryName: payload.repository.name,

src/features/hooks/domain/IPullRequestEventHandler.ts

@@ -1,5 +1,4 @@
 export interface IPullRequestOpenedEvent {
-  readonly hostURL: string
   readonly appInstallationId: number
   readonly repositoryOwner: string
   readonly repositoryName: string
@@ -8,7 +7,6 @@ export interface IPullRequestOpenedEvent {
 }
 
 export interface IPullRequestReopenedEvent {
-  readonly hostURL: string
   readonly appInstallationId: number
   readonly repositoryOwner: string
   readonly repositoryName: string
@@ -17,7 +15,6 @@ export interface IPullRequestReopenedEvent {
 }
 
 export interface IPullRequestSynchronizedEvent {
-  readonly hostURL: string
   readonly appInstallationId: number
   readonly repositoryOwner: string
   readonly repositoryName: string

src/features/hooks/domain/PullRequestCommenter.ts

@@ -2,19 +2,22 @@ import { IGitHubClient, PullRequestFile } from "@/common"
 import { getBaseFilename } from "@/common/utils"
 
 export default class PullRequestCommenter {
+  private readonly domain: string
   private readonly siteName: string
   private readonly repositoryNameSuffix: string
   private readonly projectConfigurationFilename: string
   private readonly gitHubAppId: string
   private readonly gitHubClient: IGitHubClient
 
   constructor(config: {
+    domain: string
     siteName: string
     repositoryNameSuffix: string
     projectConfigurationFilename: string
     gitHubAppId: string
     gitHubClient: IGitHubClient
   }) {
+    this.domain = config.domain
     this.siteName = config.siteName
     this.repositoryNameSuffix = config.repositoryNameSuffix
     this.projectConfigurationFilename = config.projectConfigurationFilename
@@ -23,7 +26,6 @@ export default class PullRequestCommenter {
   }
 
   async commentPullRequest(request: {
-    hostURL: string
     appInstallationId: number
     repositoryOwner: string
     repositoryName: string
@@ -33,7 +35,6 @@ export default class PullRequestCommenter {
     const files = this.getChangedFiles(await this.getYamlFiles(request))
     const commentBody = this.makeCommentBody({
       files,
-      hostURL: request.hostURL,
       owner: request.repositoryOwner,
       repositoryName: request.repositoryName,
       ref: request.ref
@@ -72,7 +73,7 @@ export default class PullRequestCommenter {
   }
 
   private async getYamlFiles(request: {
-    appInstallationId: number
+    appInstallationId: number,
     repositoryOwner: string
     repositoryName: string
     pullRequestNumber: number
@@ -87,7 +88,7 @@ export default class PullRequestCommenter {
   }
 
   private async getExistingComment(request: {
-    appInstallationId: number
+    appInstallationId: number,
     repositoryOwner: string
     repositoryName: string
     pullRequestNumber: number
@@ -104,40 +105,38 @@ export default class PullRequestCommenter {
   }
 
   private makeCommentBody(params: {
-    hostURL: string
     files: PullRequestFile[]
     owner: string
     repositoryName: string
     ref: string
   }): string {
-    const { hostURL, owner, repositoryName, ref } = params
+    const { owner, repositoryName, ref } = params
     const projectId = this.getProjectId({ repositoryName })
     const tableHTML = this.makeFileTableHTML(params)
     let result = "### 📖 Documentation Preview"
     result += "\n\n"
-    result += `The changes are now ready to previewed on <a href="${hostURL}/${owner}/${projectId}/${ref}">${this.siteName}</a> 🚀`
+    result += `The changes are now ready to previewed on <a href="${this.domain}/${owner}/${projectId}/${ref}">${this.siteName}</a> 🚀`
     if (tableHTML) {
       result += "\n\n" + tableHTML
    }
     return result
   }
 
   private makeFileTableHTML(params: {
-    hostURL: string
     files: PullRequestFile[]
     owner: string
     repositoryName: string
     ref: string
   }) {
-    const { hostURL, files, owner, repositoryName, ref } = params
+    const { files, owner, repositoryName, ref } = params
     const rows: { filename: string, status: string, button: string }[] = []
     const projectId = this.getProjectId({ repositoryName })
     // Create rows for each file
     for (const file of files) {
       const status = this.getStatusText(file)
       let button = ""
       if (file.status != "removed") {
-        let link = `${hostURL}/${owner}/${projectId}/${ref}`
+        let link = `${this.domain}/${owner}/${projectId}/${ref}`
         if (!this.isProjectConfigurationFile(file.filename)) {
           link += `/${file.filename}`
         }