Refactored styleguide ingestion logic by introducing StyleguideModel for improved structure and type safety. Replaced the previous Styleguides type with a Record type for better clarity. Removed the obsolete styleguides.types.ts file and updated related functions to accommodate these changes.

Author: yogesh-aggarwal

ingestion/src/lib/models/index.ts

@@ -16,4 +16,8 @@ export interface EmbeddingsContainer {
    contentEmbeddings?: number[]
 }
 
-export type NodeDescriptor = "Node" | "Documentation" | "Code"
+export type NodeDescriptor = "Node" | "Documentation" | "Code" | "Styleguide"
+
+export * from "./code"
+export * from "./devdoc"
+export * from "./styleguide"

ingestion/src/lib/models/styleguide.ts

@@ -0,0 +1,54 @@
+import { BaseNode, BaseRelation, EmbeddingsContainer, NodeDescriptor } from "."
+
+export type Styleguides = Record<string, string>
+export type StyleguideModelRelation = BaseRelation
+
+export interface StyleguideModelProps extends BaseNode, EmbeddingsContainer {
+   name: string
+   filePath: string
+   content: string
+   descriptor: NodeDescriptor
+}
+
+export class StyleguideModel implements StyleguideModelProps {
+   id: string
+   name: string
+   filePath: string
+   content: string
+   relations: StyleguideModelRelation[]
+   nameEmbeddings: number[]
+   codeEmbeddings: number[]
+   contentEmbeddings: number[]
+   descriptor: NodeDescriptor
+
+   constructor(props: StyleguideModelProps) {
+      this.id = props.id
+      this.name = props.name
+      this.filePath = props.filePath
+      this.content = props.content
+      this.relations = props.relations
+      this.nameEmbeddings = props.nameEmbeddings || []
+      this.codeEmbeddings = props.codeEmbeddings || []
+      this.contentEmbeddings = props.contentEmbeddings || []
+      this.descriptor = props.descriptor
+   }
+
+   getDBInsertQuery(): string {
+      return `
+         CREATE (n:Styleguide {
+            id: $id,
+            name: $name,
+            filePath: $filePath,
+            content: $content,
+            nameEmbeddings: $nameEmbeddings,
+            codeEmbeddings: $codeEmbeddings,
+            contentEmbeddings: $contentEmbeddings,
+            descriptor: $descriptor
+         })
+      `
+   }
+
+   getNodeName(): string {
+      return this.name
+   }
+} 

ingestion/src/lib/styleguides.ts

@@ -1,7 +1,5 @@
 import { writeFileSync } from "fs"
-import { CodeModel } from "./models/code"
-import { db } from "./neo4j"
-import { Styleguides } from "./styleguides.types"
+import { StyleguideModel } from "./models/styleguide"
 
 const links = [
    "https://github.com/RocketChat/Rocket.Chat/raw/develop/.prettierrc",
@@ -24,7 +22,7 @@ const links = [
    "https://github.com/RocketChat/Rocket.Chat/raw/develop/tsconfig.base.server.json",
 ]
 
-let styleguides: Styleguides = {}
+let styleguides: Record<string, string> = {}
 
 async function fetchStyleguide(url: string) {
    const res = await fetch(url)
@@ -33,7 +31,7 @@ async function fetchStyleguide(url: string) {
    styleguides[filePath] = data
 }
 
-async function fetchStyleguides(): Promise<Styleguides> {
+async function fetchStyleguides(): Promise<Record<string, string>> {
    await Promise.all(links.map(fetchStyleguide))
    const result = { ...styleguides }
    styleguides = {}
@@ -54,17 +52,16 @@ export async function insertStyleguides() {
 
    const jobs = []
    for (const [filePath, data] of Object.entries(styleguides)) {
-      const node = new CodeModel({
+      const node = new StyleguideModel({
          id: filePath,
          name: filePath,
-         type: "",
-         code: data,
          filePath: filePath,
+         content: data,
          relations: [],
          nameEmbeddings: [],
          codeEmbeddings: [],
-         descriptor: "Styleguide",
-         isFile: true,
+         contentEmbeddings: [],
+         descriptor: "Styleguide"
       })
       const job = transaction.run(node.getDBInsertQuery(), node)
       jobs.push(job)