Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Use SQLite for data storage #63

Open
wants to merge 8 commits into
base: main
Choose a base branch
from
8 changes: 6 additions & 2 deletions .github/workflows/playwright.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,13 @@ jobs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: actions/setup-node@v4
- name: Read .nvmrc
run: echo "NODE_VERSION=$(cat .nvmrc)" >> $GITHUB_OUTPUT
id: nvm
- name: Use Node.js ${{ steps.nvm.outputs.NODE_VERSION }}
uses: actions/setup-node@v4
with:
node-version: lts/*
node-version: ${{ steps.nvm.outputs.NODE_VERSION }}
- name: Install dependencies
run: script/setup
- name: Install Playwright Browsers
Expand Down
8 changes: 4 additions & 4 deletions .github/workflows/test.yml
Original file line number Diff line number Diff line change
Expand Up @@ -12,15 +12,15 @@ jobs:
runs-on: ubuntu-latest

steps:
- name: Checkout repository
uses: actions/checkout@v4
- name: Read .nvmrc
run: echo "{NODE_VERSION}={$(cat .nvmrc)}" >> $GITHUB_OUTPUT
run: echo "NODE_VERSION=$(cat .nvmrc)" >> $GITHUB_OUTPUT
id: nvm
- name: Use Node.js ${{ steps.nvm.outputs.NODE_VERSION }}
uses: actions/setup-node@v2
uses: actions/setup-node@v4
with:
node-version: ${{ steps.nvm.outputs.NODE_VERSION }}
- name: Checkout repository
uses: actions/checkout@v4
- name: Install dependencies
run: |
./script/setup
Expand Down
4 changes: 4 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -139,3 +139,7 @@ towtruck.private-key.pem
/playwright-report/
/blob-report/
/playwright/.cache/

# SQLite
*.db-wal
*.db-shm
6 changes: 5 additions & 1 deletion .vscode/extensions.json
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
{
"recommendations": ["esbenp.prettier-vscode", "ms-playwright.playwright"]
"recommendations": [
"esbenp.prettier-vscode",
"ms-playwright.playwright",
"yy0931.vscode-sqlite3-editor"
]
}
113 changes: 113 additions & 0 deletions db/index.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,113 @@
import Database from "better-sqlite3";

const dbSchemaSql = [
`CREATE TABLE IF NOT EXISTS towtruck_data (
id INTEGER PRIMARY KEY AUTOINCREMENT,
scope TEXT NOT NULL,
name TEXT NOT NULL,
key TEXT NOT NULL,
value JSONB,
UNIQUE (scope, name, key)
);`
];

const initialiseDatabase = (filename, options) => {
const db = new Database(filename, options);
db.pragma('journal_mode = WAL');

const dbSchemaStatements = dbSchemaSql.map((sql) => db.prepare(sql));

db.transaction(() => {
dbSchemaStatements.forEach((statement) => statement.run());
})();

return db;
}

export class TowtruckDatabase {
#db;

#saveStatement;
#getStatement;
#getAllForNameStatement;
#getAllForScopeStatement;

constructor(filename = "./data/towtruck.db", options) {
this.#db = initialiseDatabase(filename, options);

this.#saveStatement = this.#db.prepare("INSERT INTO towtruck_data (scope, name, key, value) VALUES (?, ?, ?, ?) ON CONFLICT DO UPDATE SET value = excluded.value;");
this.#getStatement = this.#db.prepare("SELECT value FROM towtruck_data WHERE scope = ? AND name = ? AND key = ?;");
this.#getAllForNameStatement = this.#db.prepare("SELECT key, value FROM towtruck_data WHERE scope = ? AND name = ?;");
this.#getAllForScopeStatement = this.#db.prepare("SELECT name, key, value FROM towtruck_data WHERE scope = ?;");
}

#save(scope, name, key, data) {
return this.#saveStatement.run(scope, name, key, JSON.stringify(data));
}

#get(scope, name, key) {
const json = this.#getStatement.get(scope, name, key)?.value;

if (json) return JSON.parse(json);
}

#getAllForName(scope, name) {
const rows = this.#getAllForNameStatement.all(scope, name);

const result = {};
rows.forEach((row) => result[row.key] = JSON.parse(row.value));

return result;
}

#getAllForScope(scope) {
const rows = this.#getAllForScopeStatement.all(scope);

const result = {};
rows.forEach((row) => {
if (!result[row.name]) {
result[row.name] = {};
}

result[row.name][row.key] = JSON.parse(row.value);
});

return result;
}

saveToRepository(name, key, data) {
return this.#save("repository", name, key, data);
}

getFromRepository(name, key) {
return this.#get("repository", name, key);
}

getAllFromRepository(name) {
return this.#getAllForName("repository", name);
}

getAllRepositories() {
return this.#getAllForScope("repository");
}

saveToDependency(name, key, data) {
return this.#save("dependency", name, key, data);
}

getFromDependency(name, key) {
return this.#get("dependency", name, key);
}

getAllFromDependency(name) {
return this.#getAllForName("dependency", name);
}

getAllDependencies() {
return this.#getAllForScope("dependency");
}

transaction(fn) {
return this.#db.transaction(fn);
}
};
Loading