Keenan Nicholson

Efficient Settings with Prisma and TypeScript

Tue, 24 Dec 2024 00:00:00 GMT

Since Contour is always getting updated with new features, and because database schema updates are a pain, I wanted to find a way to allow typescript to do the heavy lifting with respect to settings.

Many settings systems are very closely tied to the database schema (IE. a settings database table), or they are complexly detached from proper typing support (IE. an env file). I wanted to find a middle ground that would allow for easy expansion and easy typing, so I decided to learn a bit more about type generics in Typescript.

Generics

TypeScript, like many other languages, supports generics, which allow for assigning type at ‘runtime’. Since TypeScript is just layered on top of JavaScript, ‘runtime’ isn’t really the right word for when the types are assigned, but it’s close enough.

// A basic generic type definition
type MyGeneric<T> = {
  value: T;
}

const myNumber: MyGeneric<number> = {
  value: 5
}

const myString: MyGeneric<string> = {
  value: 'my string'
}

When using these variables, TypeScript (and therefore the IDE) will know that myString.value is a string, and myNumber.value is a number. Though a very simple example, this allows for some pretty complex type definitions that can stack in interesting ways.

Implementation

I wanted settings to be accessible efficiently during runtime, or rather, I didn’t want my fancy settings system to adjust how settings are actually pulled from the database.

The database table itself is very simple, just setting and value columns:

model Settings {
  setting String @id
  value   String

  @@map("settings")
}

Settings can be easily fetched in parallel, either by individual name or by a grouping, by using prisma operations directly:

// Multiple settings fetched at the same time by name:
const myParallelSettings = await prisma.settings.findMany({
  where: {
    setting: {
      in: ['setting1', 'setting2', 'setting3']
    }
  }
});

// Multiple settings fetched at the same time by grouping:
const myGroupedSettings = await prisma.settings.findMany({
  where: {
    setting: {
      startsWith: 'my.settings.group'
    }
  }
});

This is great, and is exactly how I wanted settings to be fetched, but prisma has no idea what the settings are, or what they should be. This is where generics (and a little bit of setup) come in.

Usage

Advent of Code

Sun, 01 Dec 2024 00:00:00 GMT

Last year, I heard about the Advent of Code about ³/₄ of the way through the month. At first, all seemed well— I buzzed through the first 4 or 5 puzzles in a couple hours. The later puzzles, however, took way longer. At the time, spending 5 hours a day during the holidays trying to catch up wasn’t something I could get behind.

This year, I am hoping to change that!

For those of you who don’t know about the Advent of Code challenge, it is an advent calendar for surprisingly detailed programming challenges, released daily for the month of december. Each challenge has two parts, with generally increasing difficulty as the month progresses, and completing them gives you stars and more importantly, 1 line of a winter-wonderland-inspired ascii art piece:

2017’s ascii art. I mean, look at that! I need it.

I’ve decided that I’ll program this year in Typescript on top of Bun (which is awesome and deserves it’s own post), and I’ve created a basic scaffold to use going forward. I know, I should probably learn rust, but hey, it’s what I’m used to right now.

Each day, my environment will populate a basic file for me to code the day’s challenges in, and downloads the program input file from AoC using the session cookie from my browser (which is required because everyone’s input prompts are unique).

/**
 * Folder structure (auto-generated):
 * day
 * ├─1
 * │ ├─input.txt
 * │ └─index.ts
 * └─2
 *   ├─input.txt
 *   └─index.ts
 */

// input.ts ####
import * as helpers from '@helpers';
/**
 * Advent of Code 2024_1, Part 1
 * @author Keenan Nicholson
 */ 
export const part1 = async () => {
  const input = await helpers.loadInput(import.meta.dir);
  console.log('');
}

/**
 * Advent of Code 2024_1, Part 2
 * @author Keenan Nicholson
 */ 
export const part2 = async () => {
  const input = await helpers.loadInput(import.meta.dir);
  console.log('');
}

Each resulting day script folder contains an input file (input.txt), and a script file (index.ts). Bun’s --watch flag is used to reload whenever the day’s script is updated, which makes trial and error very fast:

bun --watch ./

As I progress, I’ll push my solutions to my GitHub

Markdown Style Guide

Wed, 19 Jun 2024 00:00:00 GMT

Here is a sample of some basic Markdown syntax that can be used when writing Markdown content in Astro.

Headings

The following HTML <h1>—<h6> elements represent six levels of section headings. <h1> is the highest section level while <h6> is the lowest.

H1

H2

H3

H4

H5

H6

Paragraph

Xerum, quo qui aut unt expliquam qui dolut labo. Aque venitatiusda cum, voluptionse latur sitiae dolessi aut parist aut dollo enim qui voluptate ma dolestendit peritin re plis aut quas inctum laceat est volestemque commosa as cus endigna tectur, offic to cor sequas etum rerum idem sintibus eiur? Quianimin porecus evelectur, cum que nis nust voloribus ratem aut omnimi, sitatur? Quiatem. Nam, omnis sum am facea corem alique molestrunt et eos evelece arcillit ut aut eos eos nus, sin conecerem erum fuga. Ri oditatquam, ad quibus unda veliamenimin cusam et facea ipsamus es exerum sitate dolores editium rerore eost, temped molorro ratiae volorro te reribus dolorer sperchicium faceata tiustia prat.

Itatur? Quiatae cullecum rem ent aut odis in re eossequodi nonsequ idebis ne sapicia is sinveli squiatum, core et que aut hariosam ex eat.

Images

Syntax

![Alt text](./full/or/relative/path/of/image)

Output

Blockquotes

The blockquote element represents content that is quoted from another source, optionally with a citation which must be within a footer or cite element, and optionally with in-line changes such as annotations and abbreviations.

Blockquote without attribution

Syntax

> Tiam, ad mint andaepu dandae nostion secatur sequo quae.  
> **Note** that you can use _Markdown syntax_ within a blockquote.

Output

Tiam, ad mint andaepu dandae nostion secatur sequo quae.
Note that you can use Markdown syntax within a blockquote.

Blockquote with attribution

Syntax

> Don't communicate by sharing memory, share memory by communicating.<br>
> — <cite>Rob Pike[^1]</cite>

Output

Don’t communicate by sharing memory, share memory by communicating.
— Rob Pike¹

Tables

Syntax

| Italics   | Bold     | Code   |
| --------- | -------- | ------ |
| _italics_ | **bold** | `code` |

Output

Italics	Bold	Code
italics	bold	`code`

Code Blocks

Syntax

we can use 3 backticks ``` in new line and write snippet and close with 3 backticks on new line and to highlight language specific syntax, write one word of language name after first 3 backticks, for eg. html, javascript, css, markdown, typescript, txt, bash

```html
<!doctype html>
<html lang="en">
  <head>
    <meta charset="utf-8" />
    <title>Example HTML5 Document</title>
  </head>
  <body>
    <p>Test</p>
  </body>
</html>
```

Output

<!doctype html>
<html lang="en">
  <head>
    <meta charset="utf-8" />
    <title>Example HTML5 Document</title>
  </head>
  <body>
    <p>Test</p>
  </body>
</html>

List Types

Ordered List

Syntax

1. First item
2. Second item
3. Third item

Output

First item
Second item
Third item

Unordered List

Syntax

- List item
- Another item
- And another item

Output

List item
Another item
And another item

Nested list

Syntax

- Fruit
  - Apple
  - Orange
  - Banana
- Dairy
  - Milk
  - Cheese

Output

Fruit
- Apple
- Orange
- Banana
Dairy
- Milk
- Cheese

Other Elements — abbr, sub, sup, kbd, mark

Syntax

<abbr title="Graphics Interchange Format">GIF</abbr> is a bitmap image format.

H<sub>2</sub>O

X<sup>n</sup> + Y<sup>n</sup> = Z<sup>n</sup>

Press <kbd>CTRL</kbd> + <kbd>ALT</kbd> + <kbd>Delete</kbd> to end the session.

Most <mark>salamanders</mark> are nocturnal, and hunt for insects, worms, and other small creatures.

Output

GIF is a bitmap image format.

H₂O

Xⁿ + Yⁿ = Zⁿ

Press CTRL + ALT + Delete to end the session.

Most salamanders are nocturnal, and hunt for insects, worms, and other small creatures.

The above quote is excerpted from Rob Pike’s talk during Gopherfest, November 18, 2015. ↩

Example post

Fri, 15 Jul 2022 00:00:00 GMT

This is a paragraph. There can be lots of text here: Lorem ipsum odor amet, consectetuer adipiscing elit. Scelerisque lobortis sem commodo posuere sagittis. Et mattis enim nostra odio auctor massa eget urna. Vestibulum urna accumsan eget, rhoncus dapibus congue lacus. Suspendisse facilisis et est orci class elit aptent nec. Here is a link to google. Vitae arcu diam donec metus cras, purus lacus. Ligula mi cursus sem posuere netus. Sagittis inceptos duis sodales pharetra risus sagittis nam. Velit aptent hendrerit amet turpis nostra scelerisque consectetur.

Vitae imperdiet habitant habitasse adipiscing eu eros ligula. Bibendum praesent etiam bibendum in vehicula rutrum nam euismod. Rhoncus hendrerit velit ullamcorper euismod cubilia hac odio. Quisque aliquam mattis phasellus turpis ullamcorper tortor. Suscipit gravida blandit dictum dis nibh potenti torquent lacinia diam. Mollis consectetur tristique; vivamus vitae ridiculus conubia. Scelerisque ligula ultricies euismod non; aliquam finibus arcu.

{
  "test": "wow"
}

Proin taciti convallis ullamcorper, morbi consectetur donec. Enim mauris in sodales ex viverra; lectus est nostra. Erat accumsan litora sem etiam potenti platea. Nascetur accumsan bibendum magna neque sodales bibendum. Auctor curae erat eros aliquam mauris posuere sodales natoque. Purus phasellus ullamcorper curae vehicula ad.

Habitasse dui augue magnis natoque conubia dolor fames lectus platea. Tristique risus maximus curae maecenas amet aliquam; urna nulla. Habitasse elementum molestie curae mi ante in sem rutrum. Tincidunt mollis eleifend fames vitae, vivamus porttitor non. Amet mi ante nulla consequat dictum pretium laoreet. Pulvinar sit platea viverra lorem; lacinia commodo dis nulla. Cras justo conubia pellentesque; maximus ante fusce. Nostra vestibulum lobortis varius velit ante?

Eu urna quisque non dapibus id. Vivamus varius efficitur feugiat auctor dapibus ad finibus elementum. Magnis fames posuere faucibus ligula faucibus per massa. Penatibus suspendisse ornare ornare at sodales sem molestie. Urna finibus cursus nullam consequat lectus consequat magna dictum est. Etiam etiam purus at facilisis cursus venenatis semper lacus. Ut pulvinar fringilla luctus turpis adipiscing nisi natoque lorem ac. Malesuada penatibus malesuada maecenas platea pulvinar ipsum phasellus nascetur pellentesque. Montes nullam maximus maximus vulputate sapien.

Image Testing

Fri, 15 Jul 2022 00:00:00 GMT

Here is an image of a leaf

And one of a boardwalk

Don’t communicate by sharing memory, share memory by communicating.
— Rob Pike¹

The above quote is excerpted from Rob Pike’s talk during Gopherfest, November 18, 2015. ↩

Keenan Nicholson

Efficient Settings with Prisma and TypeScript

Generics

Implementation

Usage

Advent of Code

Markdown Style Guide

Headings

H1

H2

H3

H4

H5

H6

Paragraph

Images

Syntax

Output

Blockquotes

Blockquote without attribution

Syntax

Output

Blockquote with attribution

Syntax

Output

Tables

Syntax

Output

Code Blocks

Syntax

Output

List Types

Ordered List

Syntax

Output

Unordered List

Syntax

Output

Nested list

Syntax

Output

Other Elements — abbr, sub, sup, kbd, mark

Syntax

Output

Footnotes

Example post

Image Testing

Footnotes