feat: log message with dashboard url when unexpected error (#13)

src/deploy.ts

@@ -2,10 +2,13 @@ import { logDeploymentStages } from './logs'
 import { Sdk } from './sdk'
 import { Deployment, StagePollIntervalConfig } from './types'
 
-export async function deploy(sdk: Sdk, config: StagePollIntervalConfig = {}): Promise<Deployment> {
+export async function deploy(
+  sdk: Sdk,
+  pollIntervalConfig: StagePollIntervalConfig = {},
+): Promise<Deployment> {
   const deployment = await sdk.createDeployment()
 
-  await logDeploymentStages(deployment, sdk, config)
+  await logDeploymentStages(deployment, sdk, pollIntervalConfig)
 
   return await sdk.getDeploymentInfo(deployment.id)
 }

src/logs.ts

@@ -8,7 +8,7 @@ export type Log = { type: 'stage-log'; log: StageLog } | { type: 'new-stage'; na
 export async function logDeploymentStages(
   { id, stages }: Deployment,
   sdk: Sdk,
-  config: StagePollIntervalConfig = {},
+  pollIntervalConfig: StagePollIntervalConfig = {},
 ): Promise<void> {
   for (const { name } of stages) {
     let stageLogs: StageLogsResult = await sdk.getStageLogs(id, name)
@@ -26,7 +26,7 @@ export async function logDeploymentStages(
 
       if (isStageComplete(stageLogs)) break
 
-      await wait(config[name] ?? getPollInterval(stageLogs))
+      await wait(pollIntervalConfig[name] ?? getPollInterval(stageLogs))
 
       lastLogId = getLastLogId(stageLogs)
       stageLogs = await sdk.getStageLogs(id, name)
@@ -71,14 +71,19 @@ function extraStageLogs(stageName: StageName): string[] {
 
 export function getPollInterval(stage: StageLogsResult): number {
   switch (stage.name) {
+    case 'queued':
     case 'initialize':
     case 'build':
       return 15000
+    case 'clone_repo':
+    case 'deploy':
     default:
       return 5000
   }
 }
 
+// The logs endpoint doesn't offer pagination or tail logging so we have to fetch all logs every poll
+// https://api.cloudflare.com/#pages-deployment-get-deployment-stage-logs
 function getNewStageLogs(logs: StageLogsResult, lastLogId?: number): StageLog[] {
   if (lastLogId === undefined) return logs.data
   if (logs.end === lastLogId) return []

src/main.ts

@@ -1,8 +1,14 @@
-import { setFailed } from '@actions/core'
+import { endGroup, setFailed } from '@actions/core'
 import { run } from './run'
 
-try {
-  run()
-} catch (e) {
+run().catch((e) => {
+  endGroup()
+
   setFailed(e instanceof Error ? e.message : `${e}`)
-}
+
+  console.log(
+    `\nThere was an unexpected error. It's possible that your Cloudflare Pages deploy is still in progress or was successful. Go to https://dash.cloudflare.com and visit your Pages dashboard for more details.`,
+  )
+
+  return Promise.reject(e)
+})