Merge pull request #393 from Klimatbyran/staging

Release to production

src/discord.ts

@@ -15,7 +15,7 @@ import commands from './discord/commands'
 import config from './config/discord'
 import approve from './discord/interactions/approve'
 import reject from './discord/interactions/reject'
-import saveToAPI, { JobData as SaveToApiJob } from './workers/saveToAPI'
+import saveToAPI, { SaveToApiJob } from './workers/saveToAPI'
 
 const getJob = (jobId: string) => saveToAPI.queue.getJob(jobId)
 

src/discord/interactions/approve.ts

@@ -4,11 +4,12 @@ import { DiscordJob } from '../../lib/DiscordWorker'
 export default {
   async execute(interaction: ButtonInteraction, job: DiscordJob) {
     await job.updateData({ ...job.data, approved: true })
-    await job.promote()
+
     job.log(`Approving company edit: ${job.data.wikidataId}`)
-    interaction.reply({
+    await interaction.reply({
       content: `Tack för din granskning, ${interaction?.user?.username}!`,
     })
-    //discord.lockThread(threadId)
+
+    await job.promote()
   },
 }

src/lib/DiscordWorker.ts

@@ -1,4 +1,4 @@
-import { Worker, WorkerOptions, Job, Queue, Processor } from 'bullmq'
+import { Worker, WorkerOptions, Job, Queue } from 'bullmq'
 import { Message, TextChannel } from 'discord.js'
 import redis from '../config/redis'
 import discord from '../discord'
@@ -8,7 +8,6 @@ export class DiscordJob extends Job {
     url: string
     threadId: string
     channelId: string
-    wikidataId?: string
     messageId?: string
   }
 

src/lib/prisma.ts

@@ -552,7 +552,7 @@ export async function updateIndustry(
   })
 }
 
-export async function ensureReportingPeriodExists(
+export async function upsertReportingPeriod(
   company: Company,
   metadata: Parameters<typeof prisma.metadata.create>[0]['data'],
   {
@@ -590,3 +590,53 @@ export async function ensureReportingPeriodExists(
     },
   })
 }
+
+export async function upsertEmissions({
+  emissionsId,
+  year,
+  companyId,
+}: {
+  emissionsId: number
+  year: string
+  companyId: string
+}) {
+  return prisma.emissions.upsert({
+    where: { id: emissionsId },
+    update: {},
+    create: {
+      reportingPeriod: {
+        connect: {
+          reportingPeriodId: {
+            year,
+            companyId,
+          },
+        },
+      },
+    },
+  })
+}
+
+export async function upsertEconomy({
+  economyId,
+  companyId,
+  year,
+}: {
+  economyId: number
+  companyId: string
+  year: string
+}) {
+  return prisma.economy.upsert({
+    where: { id: economyId },
+    update: {},
+    create: {
+      reportingPeriod: {
+        connect: {
+          reportingPeriodId: {
+            year,
+            companyId,
+          },
+        },
+      },
+    },
+  })
+}

src/lib/saveUtils.ts

@@ -0,0 +1,72 @@
+import { getReportingPeriodDates } from './reportingPeriodDates'
+
+export function formatAsReportingPeriods(
+  entries: { year: number }[],
+  fiscalYear: { startMonth: number; endMonth: number },
+  category: 'emissions' | 'economy'
+) {
+  return entries.map(({ year, ...data }) => {
+    const [startDate, endDate] = getReportingPeriodDates(
+      year,
+      fiscalYear.startMonth,
+      fiscalYear.endMonth
+    )
+    return {
+      startDate,
+      endDate,
+      [category]:
+        category === 'economy'
+          ? (data as { economy: any }).economy
+          : {
+              ...data,
+            },
+    }
+  })
+}
+
+import { askPrompt } from './openai'
+
+export const defaultMetadata = (url: string) => ({
+  source: url,
+  comment: 'Parsed by Garbo AI',
+})
+
+/**
+ * Recusrively remove the provided keys from all levels of the object.
+ *
+ * Handles circular references.
+ * Source: https://stackoverflow.com/a/72493889
+ */
+const recursiveOmit = <T extends Object>(
+  obj: T,
+  keys: Set<string>,
+  visitedIn?: Set<any>
+): T => {
+  if (obj == null || typeof obj !== 'object') return obj
+  const visited = visitedIn ?? new Set()
+  visited.add(obj)
+  Object.entries(obj).forEach(([key, val]) => {
+    if (keys.has(key)) {
+      delete obj[key as keyof T]
+    } else if (typeof val === 'object' && !visited.has(val)) {
+      recursiveOmit(val, keys, visited)
+    }
+  })
+  return obj
+}
+
+export const askDiff = async (before: any, after: any) => {
+  if (!before || !after) return 'NO_CHANGES'
+  return await askPrompt(
+    `What is changed between these two json values? Please respond in clear text with markdown formatting. 
+The purpose is to let an editor approve the changes or suggest changes in Discord.
+Be as brief as possible. Never be technical - meaning no comments about structure changes, fields renames etc.
+Focus only on the actual values that have changed.
+When handling years and ambiguous dates, always use the last year in the period (e.g. startDate: 2020 - endDate: 2021 should be referred to as 2021).
+NEVER REPEAT UNCHANGED VALUES OR UNCHANGED YEARS! If nothing important has changed, just write "NO_CHANGES".`,
+    JSON.stringify({
+      before: recursiveOmit(structuredClone(before), new Set(['metadata'])),
+      after: recursiveOmit(structuredClone(after), new Set(['metadata'])),
+    })
+  )
+}

src/prompts/followUp/economy.ts

@@ -27,6 +27,8 @@ export const schema = z.object({
 // NOTE: Maybe split this into two parts, one for turnover and another for employees, to allow re-running them separately
 
 export const prompt = `
+*** Golden Rule ***
+- Extract values only if explicitly available in the context. Do not infer or create data. Leave optional fields absent if no data is provided.
 *** Turnover ***
 - Extract turnover as a numerical value. Use the turnover field to specify the turnover (intäkter, omsättning) of the company. If the currency is not specified, assume SEK. 
   Be as accurate as possible. Extract this data for all available years.
@@ -39,7 +41,9 @@ export const prompt = `
 - Extract the number of employees for all available years. The unit can be for example "FTE" (full-time equivalent) or average number of employees during the year.
 *** Dates: ***
 - if no year is specified, assume the current year ${new Date().getFullYear()}
-Example, follow the format below. Do not use markdown in the output:
+
+*** Example***
+This is only an example format; do not include this specific data in the output and do not use markdown in the output:
 {
   "economy": [
     {

src/prompts/followUp/scope12.ts

@@ -35,12 +35,20 @@ const schema = z.object({
 })
 
 const prompt = `
+*** Golden Rule ***
+- Extract values only if explicitly available in the context. Do not infer or create data. Leave optional fields absent if no data is provided.
+
 Extract scope 1 and 2 emissions according to the GHG protocol (CO2e). Include all years you can find and never exclude the latest year.
-Include market-based and location-based in scope 2. Always use tonnes CO2e as the unit, so if emissions are presented in other units (for example, in kilotonnes), convert this to tonnes.
+Include market-based and location-based in scope 2. 
+
+Always use tonnes CO2e as the unit, so if emissions are presented in other units (for example, in kilotonnes), convert this to tonnes.
+- 1 kton → 1000 tCO2
+- 1 Mton → 1000000 tCO2
 
 NEVER CALCULATE ANY EMISSIONS. ONLY REPORT THE DATA AS IT IS IN THE PDF. If you can't find any data or if you are uncertain, report it as null. Do not use markdown in the output.
 
-Example - feel free to add more fields and relevant data:
+*** Example***
+This is only an example format; do not include this specific data in the output and do not use markdown in the output:
 {
   "scope12": [{
     "year": 2023,

src/routes/middlewares.ts

@@ -12,7 +12,11 @@ import { validateRequest, validateRequestBody } from './zod-middleware'
 import { z, ZodError } from 'zod'
 import cors, { CorsOptionsDelegate } from 'cors'
 
-import { ensureReportingPeriodExists } from '../lib/prisma'
+import {
+  upsertEconomy,
+  upsertEmissions,
+  upsertReportingPeriod,
+} from '../lib/prisma'
 import { GarboAPIError } from '../lib/garbo-api-error'
 import apiConfig from '../config/api'
 
@@ -164,11 +168,12 @@ export const reportingPeriod =
     if (req.method === 'POST' || req.method === 'PATCH') {
       // TODO: Only allow creating a reporting period when updating other data
       // TODO: Maybe throw 404 if the reporting period was not found and it is a GET request
-      const reportingPeriod = await ensureReportingPeriodExists(
-        company,
-        metadata,
-        { startDate, endDate, reportURL, year }
-      )
+      const reportingPeriod = await upsertReportingPeriod(company, metadata, {
+        startDate,
+        endDate,
+        reportURL,
+        year,
+      })
 
       res.locals.reportingPeriod = reportingPeriod
     }
@@ -180,21 +185,11 @@ export const ensureEmissionsExists =
   (prisma: PrismaClient) =>
   async (req: Request, res: Response, next: NextFunction) => {
     const reportingPeriod = res.locals.reportingPeriod
-    const emissionsId = res.locals.reportingPeriod.emissionsId ?? 0
-
-    const emissions = await prisma.emissions.upsert({
-      where: { id: emissionsId ?? 0 },
-      update: {},
-      create: {
-        reportingPeriod: {
-          connect: {
-            reportingPeriodId: {
-              year: reportingPeriod.year,
-              companyId: reportingPeriod.companyId,
-            },
-          },
-        },
-      },
+
+    const emissions = await upsertEmissions({
+      emissionsId: reportingPeriod.emissionsId ?? 0,
+      companyId: res.locals.company.wikidataId,
+      year: reportingPeriod.year,
     })
 
     res.locals.emissions = emissions
@@ -205,21 +200,11 @@ export const ensureEconomyExists =
   (prisma: PrismaClient) =>
   async (req: Request, res: Response, next: NextFunction) => {
     const reportingPeriod = res.locals.reportingPeriod
-    const economyId = res.locals.reportingPeriod.economyId ?? 0
-
-    const economy = await prisma.economy.upsert({
-      where: { id: economyId },
-      update: {},
-      create: {
-        reportingPeriod: {
-          connect: {
-            reportingPeriodId: {
-              year: reportingPeriod.year,
-              companyId: reportingPeriod.companyId,
-            },
-          },
-        },
-      },
+
+    const economy = await upsertEconomy({
+      economyId: reportingPeriod.economyId ?? 0,
+      companyId: reportingPeriod.companyId,
+      year: reportingPeriod.year,
     })
 
     res.locals.economy = economy