mirror of
https://github.com/TriliumNext/Notes.git
synced 2025-09-24 21:41:30 +08:00
Merge branch 'develop' into fix/llm-becca-sync
This commit is contained in:
commit
4aa936bd2b
@ -1,12 +0,0 @@
|
|||||||
POST {{triliumHost}}/etapi/auth/login
|
|
||||||
Content-Type: application/json
|
|
||||||
|
|
||||||
{
|
|
||||||
"password": "1234"
|
|
||||||
}
|
|
||||||
|
|
||||||
> {%
|
|
||||||
client.assert(response.status === 201);
|
|
||||||
|
|
||||||
client.global.set("authToken", response.body.authToken);
|
|
||||||
%}
|
|
@ -1,43 +0,0 @@
|
|||||||
### Test regular API metrics endpoint (requires session authentication)
|
|
||||||
|
|
||||||
### Get metrics from regular API (default Prometheus format)
|
|
||||||
GET {{triliumHost}}/api/metrics
|
|
||||||
|
|
||||||
> {%
|
|
||||||
client.test("API metrics endpoint returns Prometheus format by default", function() {
|
|
||||||
client.assert(response.status === 200, "Response status is not 200");
|
|
||||||
client.assert(response.headers["content-type"].includes("text/plain"), "Content-Type should be text/plain");
|
|
||||||
client.assert(response.body.includes("trilium_info"), "Should contain trilium_info metric");
|
|
||||||
client.assert(response.body.includes("trilium_notes_total"), "Should contain trilium_notes_total metric");
|
|
||||||
client.assert(response.body.includes("# HELP"), "Should contain HELP comments");
|
|
||||||
client.assert(response.body.includes("# TYPE"), "Should contain TYPE comments");
|
|
||||||
});
|
|
||||||
%}
|
|
||||||
|
|
||||||
### Get metrics in JSON format
|
|
||||||
GET {{triliumHost}}/api/metrics?format=json
|
|
||||||
|
|
||||||
> {%
|
|
||||||
client.test("API metrics endpoint returns JSON when requested", function() {
|
|
||||||
client.assert(response.status === 200, "Response status is not 200");
|
|
||||||
client.assert(response.headers["content-type"].includes("application/json"), "Content-Type should be application/json");
|
|
||||||
client.assert(response.body.version, "Version info not present");
|
|
||||||
client.assert(response.body.database, "Database info not present");
|
|
||||||
client.assert(response.body.timestamp, "Timestamp not present");
|
|
||||||
client.assert(typeof response.body.database.totalNotes === 'number', "Total notes should be a number");
|
|
||||||
client.assert(typeof response.body.database.activeNotes === 'number', "Active notes should be a number");
|
|
||||||
client.assert(response.body.noteTypes, "Note types breakdown not present");
|
|
||||||
client.assert(response.body.attachmentTypes, "Attachment types breakdown not present");
|
|
||||||
client.assert(response.body.statistics, "Statistics not present");
|
|
||||||
});
|
|
||||||
%}
|
|
||||||
|
|
||||||
### Test invalid format parameter
|
|
||||||
GET {{triliumHost}}/api/metrics?format=xml
|
|
||||||
|
|
||||||
> {%
|
|
||||||
client.test("Invalid format parameter returns error", function() {
|
|
||||||
client.assert(response.status === 500, "Response status should be 500");
|
|
||||||
client.assert(response.body.message.includes("prometheus"), "Error message should mention supported formats");
|
|
||||||
});
|
|
||||||
%}
|
|
@ -1,7 +0,0 @@
|
|||||||
GET {{triliumHost}}/etapi/app-info
|
|
||||||
Authorization: {{authToken}}
|
|
||||||
|
|
||||||
> {%
|
|
||||||
client.assert(response.status === 200);
|
|
||||||
client.assert(response.body.clipperProtocolVersion === "1.0");
|
|
||||||
%}
|
|
@ -1,21 +0,0 @@
|
|||||||
GET {{triliumHost}}/etapi/app-info
|
|
||||||
Authorization: Basic etapi {{authToken}}
|
|
||||||
|
|
||||||
> {%
|
|
||||||
client.assert(response.status === 200);
|
|
||||||
client.assert(response.body.clipperProtocolVersion === "1.0");
|
|
||||||
%}
|
|
||||||
|
|
||||||
###
|
|
||||||
|
|
||||||
GET {{triliumHost}}/etapi/app-info
|
|
||||||
Authorization: Basic etapi wrong
|
|
||||||
|
|
||||||
> {% client.assert(response.status === 401); %}
|
|
||||||
|
|
||||||
###
|
|
||||||
|
|
||||||
GET {{triliumHost}}/etapi/app-info
|
|
||||||
Authorization: Basic wrong {{authToken}}
|
|
||||||
|
|
||||||
> {% client.assert(response.status === 401); %}
|
|
@ -1,4 +0,0 @@
|
|||||||
PUT {{triliumHost}}/etapi/backup/etapi_test
|
|
||||||
Authorization: {{authToken}}
|
|
||||||
|
|
||||||
> {% client.assert(response.status === 201); %}
|
|
@ -1,158 +0,0 @@
|
|||||||
POST {{triliumHost}}/etapi/create-note
|
|
||||||
Authorization: {{authToken}}
|
|
||||||
Content-Type: application/json
|
|
||||||
|
|
||||||
{
|
|
||||||
"noteId": "forcedId{{$randomInt}}",
|
|
||||||
"parentNoteId": "root",
|
|
||||||
"title": "Hello",
|
|
||||||
"type": "text",
|
|
||||||
"content": "Hi there!",
|
|
||||||
"dateCreated": "2023-08-21 23:38:51.123+0200",
|
|
||||||
"utcDateCreated": "2023-08-21 23:38:51.123Z"
|
|
||||||
}
|
|
||||||
|
|
||||||
> {%
|
|
||||||
client.assert(response.status === 201);
|
|
||||||
client.assert(response.body.note.noteId.startsWith("forcedId"));
|
|
||||||
client.assert(response.body.note.title == "Hello");
|
|
||||||
client.assert(response.body.note.dateCreated == "2023-08-21 23:38:51.123+0200");
|
|
||||||
client.assert(response.body.note.utcDateCreated == "2023-08-21 23:38:51.123Z");
|
|
||||||
client.assert(response.body.branch.parentNoteId == "root");
|
|
||||||
|
|
||||||
client.log(`Created note ` + response.body.note.noteId + ` and branch ` + response.body.branch.branchId);
|
|
||||||
|
|
||||||
client.global.set("createdNoteId", response.body.note.noteId);
|
|
||||||
client.global.set("createdBranchId", response.body.branch.branchId);
|
|
||||||
%}
|
|
||||||
|
|
||||||
### Clone to another location
|
|
||||||
|
|
||||||
POST {{triliumHost}}/etapi/branches
|
|
||||||
Authorization: {{authToken}}
|
|
||||||
Content-Type: application/json
|
|
||||||
|
|
||||||
{
|
|
||||||
"noteId": "{{createdNoteId}}",
|
|
||||||
"parentNoteId": "_hidden"
|
|
||||||
}
|
|
||||||
|
|
||||||
> {%
|
|
||||||
client.assert(response.status === 201);
|
|
||||||
client.assert(response.body.parentNoteId == "_hidden");
|
|
||||||
|
|
||||||
client.global.set("clonedBranchId", response.body.branchId);
|
|
||||||
|
|
||||||
client.log(`Created cloned branch ` + response.body.branchId);
|
|
||||||
%}
|
|
||||||
|
|
||||||
###
|
|
||||||
|
|
||||||
GET {{triliumHost}}/etapi/notes/{{createdNoteId}}
|
|
||||||
Authorization: {{authToken}}
|
|
||||||
|
|
||||||
> {%
|
|
||||||
client.assert(response.status === 200);
|
|
||||||
client.assert(response.body.noteId == client.global.get("createdNoteId"));
|
|
||||||
client.assert(response.body.title == "Hello");
|
|
||||||
// order is not defined and may fail in the future
|
|
||||||
client.assert(response.body.parentBranchIds[0] == client.global.get("clonedBranchId"))
|
|
||||||
client.assert(response.body.parentBranchIds[1] == client.global.get("createdBranchId"));
|
|
||||||
%}
|
|
||||||
|
|
||||||
###
|
|
||||||
|
|
||||||
GET {{triliumHost}}/etapi/notes/{{createdNoteId}}/content
|
|
||||||
Authorization: {{authToken}}
|
|
||||||
|
|
||||||
> {%
|
|
||||||
client.assert(response.status === 200);
|
|
||||||
client.assert(response.body == "Hi there!");
|
|
||||||
%}
|
|
||||||
|
|
||||||
###
|
|
||||||
|
|
||||||
GET {{triliumHost}}/etapi/branches/{{createdBranchId}}
|
|
||||||
Authorization: {{authToken}}
|
|
||||||
|
|
||||||
> {%
|
|
||||||
client.assert(response.status === 200);
|
|
||||||
client.assert(response.body.branchId == client.global.get("createdBranchId"));
|
|
||||||
client.assert(response.body.parentNoteId == "root");
|
|
||||||
%}
|
|
||||||
|
|
||||||
###
|
|
||||||
|
|
||||||
GET {{triliumHost}}/etapi/branches/{{clonedBranchId}}
|
|
||||||
Authorization: {{authToken}}
|
|
||||||
|
|
||||||
> {%
|
|
||||||
client.assert(response.status === 200);
|
|
||||||
client.assert(response.body.branchId == client.global.get("clonedBranchId"));
|
|
||||||
client.assert(response.body.parentNoteId == "_hidden");
|
|
||||||
%}
|
|
||||||
|
|
||||||
###
|
|
||||||
|
|
||||||
POST {{triliumHost}}/etapi/attributes
|
|
||||||
Content-Type: application/json
|
|
||||||
Authorization: {{authToken}}
|
|
||||||
|
|
||||||
{
|
|
||||||
"attributeId": "forcedAttributeId{{$randomInt}}",
|
|
||||||
"noteId": "{{createdNoteId}}",
|
|
||||||
"type": "label",
|
|
||||||
"name": "mylabel",
|
|
||||||
"value": "val",
|
|
||||||
"isInheritable": true
|
|
||||||
}
|
|
||||||
|
|
||||||
> {%
|
|
||||||
client.assert(response.status === 201);
|
|
||||||
client.assert(response.body.attributeId.startsWith("forcedAttributeId"));
|
|
||||||
|
|
||||||
client.global.set("createdAttributeId", response.body.attributeId);
|
|
||||||
%}
|
|
||||||
|
|
||||||
###
|
|
||||||
|
|
||||||
GET {{triliumHost}}/etapi/attributes/{{createdAttributeId}}
|
|
||||||
Authorization: {{authToken}}
|
|
||||||
|
|
||||||
> {%
|
|
||||||
client.assert(response.status === 200);
|
|
||||||
client.assert(response.body.attributeId == client.global.get("createdAttributeId"));
|
|
||||||
%}
|
|
||||||
|
|
||||||
###
|
|
||||||
|
|
||||||
POST {{triliumHost}}/etapi/attachments
|
|
||||||
Content-Type: application/json
|
|
||||||
Authorization: {{authToken}}
|
|
||||||
|
|
||||||
{
|
|
||||||
"ownerId": "{{createdNoteId}}",
|
|
||||||
"role": "file",
|
|
||||||
"mime": "plain/text",
|
|
||||||
"title": "my attachment",
|
|
||||||
"content": "my text"
|
|
||||||
}
|
|
||||||
|
|
||||||
> {%
|
|
||||||
client.assert(response.status === 201);
|
|
||||||
|
|
||||||
client.global.set("createdAttachmentId", response.body.attachmentId);
|
|
||||||
%}
|
|
||||||
|
|
||||||
###
|
|
||||||
|
|
||||||
GET {{triliumHost}}/etapi/attachments/{{createdAttachmentId}}
|
|
||||||
Authorization: {{authToken}}
|
|
||||||
|
|
||||||
> {%
|
|
||||||
client.assert(response.status === 200);
|
|
||||||
client.assert(response.body.attachmentId == client.global.get("createdAttachmentId"));
|
|
||||||
client.assert(response.body.role == "file");
|
|
||||||
client.assert(response.body.mime == "plain/text");
|
|
||||||
client.assert(response.body.title == "my attachment");
|
|
||||||
%}
|
|
@ -1,34 +0,0 @@
|
|||||||
POST {{triliumHost}}/etapi/auth/login
|
|
||||||
Content-Type: application/json
|
|
||||||
|
|
||||||
{
|
|
||||||
"password": "1234"
|
|
||||||
}
|
|
||||||
|
|
||||||
> {%
|
|
||||||
client.assert(response.status === 201);
|
|
||||||
|
|
||||||
client.global.set("testAuthToken", response.body.authToken);
|
|
||||||
%}
|
|
||||||
|
|
||||||
###
|
|
||||||
|
|
||||||
GET {{triliumHost}}/etapi/notes/root
|
|
||||||
Authorization: {{testAuthToken}}
|
|
||||||
|
|
||||||
> {% client.assert(response.status === 200); %}
|
|
||||||
|
|
||||||
###
|
|
||||||
|
|
||||||
POST {{triliumHost}}/etapi/auth/logout
|
|
||||||
Authorization: {{testAuthToken}}
|
|
||||||
Content-Type: application/json
|
|
||||||
|
|
||||||
> {% client.assert(response.status === 204); %}
|
|
||||||
|
|
||||||
###
|
|
||||||
|
|
||||||
GET {{triliumHost}}/etapi/notes/root
|
|
||||||
Authorization: {{testAuthToken}}
|
|
||||||
|
|
||||||
> {% client.assert(response.status === 401); %}
|
|
@ -1,109 +0,0 @@
|
|||||||
GET {{triliumHost}}/etapi/notes?search=aaa
|
|
||||||
|
|
||||||
> {% client.assert(response.status === 401); %}
|
|
||||||
|
|
||||||
###
|
|
||||||
|
|
||||||
GET {{triliumHost}}/etapi/notes/root
|
|
||||||
|
|
||||||
> {% client.assert(response.status === 401); %}
|
|
||||||
|
|
||||||
###
|
|
||||||
|
|
||||||
PATCH {{triliumHost}}/etapi/notes/root
|
|
||||||
Authorization: fakeauth
|
|
||||||
|
|
||||||
> {% client.assert(response.status === 401); %}
|
|
||||||
|
|
||||||
###
|
|
||||||
|
|
||||||
DELETE {{triliumHost}}/etapi/notes/root
|
|
||||||
Authorization: fakeauth
|
|
||||||
|
|
||||||
> {% client.assert(response.status === 401); %}
|
|
||||||
|
|
||||||
###
|
|
||||||
|
|
||||||
GET {{triliumHost}}/etapi/branches/root
|
|
||||||
Authorization: fakeauth
|
|
||||||
|
|
||||||
> {% client.assert(response.status === 401); %}
|
|
||||||
|
|
||||||
###
|
|
||||||
|
|
||||||
PATCH {{triliumHost}}/etapi/branches/root
|
|
||||||
|
|
||||||
> {% client.assert(response.status === 401); %}
|
|
||||||
|
|
||||||
###
|
|
||||||
|
|
||||||
DELETE {{triliumHost}}/etapi/branches/root
|
|
||||||
|
|
||||||
> {% client.assert(response.status === 401); %}
|
|
||||||
|
|
||||||
###
|
|
||||||
|
|
||||||
GET {{triliumHost}}/etapi/attributes/000
|
|
||||||
|
|
||||||
> {% client.assert(response.status === 401); %}
|
|
||||||
|
|
||||||
###
|
|
||||||
|
|
||||||
PATCH {{triliumHost}}/etapi/attributes/000
|
|
||||||
|
|
||||||
> {% client.assert(response.status === 401); %}
|
|
||||||
|
|
||||||
###
|
|
||||||
|
|
||||||
DELETE {{triliumHost}}/etapi/attributes/000
|
|
||||||
|
|
||||||
> {% client.assert(response.status === 401); %}
|
|
||||||
|
|
||||||
###
|
|
||||||
|
|
||||||
GET {{triliumHost}}/etapi/inbox/2022-02-22
|
|
||||||
|
|
||||||
> {% client.assert(response.status === 401); %}
|
|
||||||
|
|
||||||
###
|
|
||||||
|
|
||||||
GET {{triliumHost}}/etapi/calendar/days/2022-02-22
|
|
||||||
Authorization: fakeauth
|
|
||||||
|
|
||||||
> {% client.assert(response.status === 401); %}
|
|
||||||
|
|
||||||
###
|
|
||||||
|
|
||||||
GET {{triliumHost}}/etapi/calendar/weeks/2022-02-22
|
|
||||||
|
|
||||||
> {% client.assert(response.status === 401); %}
|
|
||||||
|
|
||||||
###
|
|
||||||
|
|
||||||
GET {{triliumHost}}/etapi/calendar/months/2022-02
|
|
||||||
|
|
||||||
> {% client.assert(response.status === 401); %}
|
|
||||||
|
|
||||||
###
|
|
||||||
|
|
||||||
GET {{triliumHost}}/etapi/calendar/years/2022
|
|
||||||
|
|
||||||
> {% client.assert(response.status === 401); %}
|
|
||||||
|
|
||||||
###
|
|
||||||
|
|
||||||
POST {{triliumHost}}/etapi/create-note
|
|
||||||
|
|
||||||
> {% client.assert(response.status === 401); %}
|
|
||||||
|
|
||||||
###
|
|
||||||
|
|
||||||
GET {{triliumHost}}/etapi/app-info
|
|
||||||
|
|
||||||
> {% client.assert(response.status === 401); %}
|
|
||||||
|
|
||||||
### Fake URL will get a 404 even without token
|
|
||||||
|
|
||||||
GET {{triliumHost}}/etapi/zzzzzz
|
|
||||||
|
|
||||||
> {% client.assert(response.status === 404); %}
|
|
@ -1,4 +0,0 @@
|
|||||||
POST {{triliumHost}}/etapi/refresh-note-ordering/root
|
|
||||||
Authorization: {{authToken}}
|
|
||||||
|
|
||||||
> {% client.assert(response.status === 200); %}
|
|
@ -1,39 +0,0 @@
|
|||||||
POST {{triliumHost}}/etapi/create-note
|
|
||||||
Authorization: {{authToken}}
|
|
||||||
Content-Type: application/json
|
|
||||||
|
|
||||||
{
|
|
||||||
"parentNoteId": "root",
|
|
||||||
"title": "title",
|
|
||||||
"type": "text",
|
|
||||||
"content": "{{$uuid}}"
|
|
||||||
}
|
|
||||||
|
|
||||||
> {% client.global.set("createdNoteId", response.body.note.noteId); %}
|
|
||||||
|
|
||||||
###
|
|
||||||
|
|
||||||
GET {{triliumHost}}/etapi/notes/{{createdNoteId}}/content
|
|
||||||
Authorization: {{authToken}}
|
|
||||||
|
|
||||||
> {% client.global.set("content", response.body); %}
|
|
||||||
|
|
||||||
###
|
|
||||||
|
|
||||||
GET {{triliumHost}}/etapi/notes?search={{content}}&debug=true
|
|
||||||
Authorization: {{authToken}}
|
|
||||||
|
|
||||||
> {%
|
|
||||||
client.assert(response.status === 200);
|
|
||||||
client.assert(response.body.results.length === 1);
|
|
||||||
%}
|
|
||||||
|
|
||||||
### Same but with fast search which doesn't look in the content so 0 notes should be found
|
|
||||||
|
|
||||||
GET {{triliumHost}}/etapi/notes?search={{content}}&fastSearch=true
|
|
||||||
Authorization: {{authToken}}
|
|
||||||
|
|
||||||
> {%
|
|
||||||
client.assert(response.status === 200);
|
|
||||||
client.assert(response.body.results.length === 0);
|
|
||||||
%}
|
|
48
apps/server/spec/etapi/api-metrics.spec.ts
Normal file
48
apps/server/spec/etapi/api-metrics.spec.ts
Normal file
@ -0,0 +1,48 @@
|
|||||||
|
import { Application } from "express";
|
||||||
|
import { beforeAll, describe, expect, it } from "vitest";
|
||||||
|
import buildApp from "../../src/app.js";
|
||||||
|
import supertest from "supertest";
|
||||||
|
|
||||||
|
let app: Application;
|
||||||
|
let token: string;
|
||||||
|
|
||||||
|
// TODO: This is an API test, not ETAPI.
|
||||||
|
|
||||||
|
describe("api/metrics", () => {
|
||||||
|
beforeAll(async () => {
|
||||||
|
app = await buildApp();
|
||||||
|
});
|
||||||
|
|
||||||
|
it("returns Prometheus format by default", async () => {
|
||||||
|
const response = await supertest(app)
|
||||||
|
.get("/api/metrics")
|
||||||
|
.expect(200);
|
||||||
|
expect(response.headers["content-type"]).toContain("text/plain");
|
||||||
|
expect(response.text).toContain("trilium_info");
|
||||||
|
expect(response.text).toContain("trilium_notes_total");
|
||||||
|
expect(response.text).toContain("# HELP");
|
||||||
|
expect(response.text).toContain("# TYPE");
|
||||||
|
});
|
||||||
|
|
||||||
|
it("returns JSON when requested", async() => {
|
||||||
|
const response = await supertest(app)
|
||||||
|
.get("/api/metrics?format=json")
|
||||||
|
.expect(200);
|
||||||
|
expect(response.headers["content-type"]).toContain("application/json");
|
||||||
|
expect(response.body.version).toBeTruthy();
|
||||||
|
expect(response.body.database).toBeTruthy();
|
||||||
|
expect(response.body.timestamp).toBeTruthy();
|
||||||
|
expect(response.body.database.totalNotes).toBeTypeOf("number");
|
||||||
|
expect(response.body.database.activeNotes).toBeTypeOf("number");
|
||||||
|
expect(response.body.noteTypes).toBeTruthy();
|
||||||
|
expect(response.body.attachmentTypes).toBeTruthy();
|
||||||
|
expect(response.body.statistics).toBeTruthy();
|
||||||
|
});
|
||||||
|
|
||||||
|
it("returns error on invalid format", async() => {
|
||||||
|
const response = await supertest(app)
|
||||||
|
.get("/api/metrics?format=xml")
|
||||||
|
.expect(500);
|
||||||
|
expect(response.body.message).toContain("prometheus");
|
||||||
|
});
|
||||||
|
});
|
20
apps/server/spec/etapi/app-info.spec.ts
Normal file
20
apps/server/spec/etapi/app-info.spec.ts
Normal file
@ -0,0 +1,20 @@
|
|||||||
|
import { Application } from "express";
|
||||||
|
import { beforeAll, describe, expect, it } from "vitest";
|
||||||
|
import buildApp from "../../src/app.js";
|
||||||
|
import supertest from "supertest";
|
||||||
|
|
||||||
|
let app: Application;
|
||||||
|
let token: string;
|
||||||
|
|
||||||
|
describe("etapi/app-info", () => {
|
||||||
|
beforeAll(async () => {
|
||||||
|
app = await buildApp();
|
||||||
|
});
|
||||||
|
|
||||||
|
it("retrieves correct app info", async () => {
|
||||||
|
const response = await supertest(app)
|
||||||
|
.get("/etapi/app-info")
|
||||||
|
.expect(200);
|
||||||
|
expect(response.body.clipperProtocolVersion).toBe("1.0");
|
||||||
|
});
|
||||||
|
});
|
54
apps/server/spec/etapi/basic-auth.spec.ts
Normal file
54
apps/server/spec/etapi/basic-auth.spec.ts
Normal file
@ -0,0 +1,54 @@
|
|||||||
|
import { Application } from "express";
|
||||||
|
import { beforeAll, describe, expect, it } from "vitest";
|
||||||
|
import supertest from "supertest";
|
||||||
|
import { login } from "./utils.js";
|
||||||
|
import config from "../../src/services/config.js";
|
||||||
|
|
||||||
|
let app: Application;
|
||||||
|
let token: string;
|
||||||
|
|
||||||
|
const USER = "etapi";
|
||||||
|
const URL = "/etapi/notes/root";
|
||||||
|
|
||||||
|
describe("basic-auth", () => {
|
||||||
|
beforeAll(async () => {
|
||||||
|
config.General.noAuthentication = false;
|
||||||
|
const buildApp = (await (import("../../src/app.js"))).default;
|
||||||
|
app = await buildApp();
|
||||||
|
token = await login(app);
|
||||||
|
});
|
||||||
|
|
||||||
|
it("auth token works", async () => {
|
||||||
|
const response = await supertest(app)
|
||||||
|
.get(URL)
|
||||||
|
.auth(USER, token, { "type": "basic"})
|
||||||
|
.expect(200);
|
||||||
|
});
|
||||||
|
|
||||||
|
it("rejects wrong password", async () => {
|
||||||
|
const response = await supertest(app)
|
||||||
|
.get(URL)
|
||||||
|
.auth(USER, "wrong", { "type": "basic"})
|
||||||
|
.expect(401);
|
||||||
|
});
|
||||||
|
|
||||||
|
it("rejects wrong user", async () => {
|
||||||
|
const response = await supertest(app)
|
||||||
|
.get(URL)
|
||||||
|
.auth("wrong", token, { "type": "basic"})
|
||||||
|
.expect(401);
|
||||||
|
});
|
||||||
|
|
||||||
|
it("logs out", async () => {
|
||||||
|
await supertest(app)
|
||||||
|
.post("/etapi/auth/logout")
|
||||||
|
.auth(USER, token, { "type": "basic"})
|
||||||
|
.expect(204);
|
||||||
|
|
||||||
|
// Ensure we can't access it anymore
|
||||||
|
await supertest(app)
|
||||||
|
.get("/etapi/notes/root")
|
||||||
|
.auth(USER, token, { "type": "basic"})
|
||||||
|
.expect(401);
|
||||||
|
});
|
||||||
|
});
|
26
apps/server/spec/etapi/create-backup.spec.ts
Normal file
26
apps/server/spec/etapi/create-backup.spec.ts
Normal file
@ -0,0 +1,26 @@
|
|||||||
|
import { Application } from "express";
|
||||||
|
import { beforeAll, describe, expect, it } from "vitest";
|
||||||
|
import supertest from "supertest";
|
||||||
|
import { login } from "./utils.js";
|
||||||
|
import config from "../../src/services/config.js";
|
||||||
|
|
||||||
|
let app: Application;
|
||||||
|
let token: string;
|
||||||
|
|
||||||
|
const USER = "etapi";
|
||||||
|
|
||||||
|
describe("etapi/backup", () => {
|
||||||
|
beforeAll(async () => {
|
||||||
|
config.General.noAuthentication = false;
|
||||||
|
const buildApp = (await (import("../../src/app.js"))).default;
|
||||||
|
app = await buildApp();
|
||||||
|
token = await login(app);
|
||||||
|
});
|
||||||
|
|
||||||
|
it("backup works", async () => {
|
||||||
|
const response = await supertest(app)
|
||||||
|
.put("/etapi/backup/etapi_test")
|
||||||
|
.auth(USER, token, { "type": "basic"})
|
||||||
|
.expect(201);
|
||||||
|
});
|
||||||
|
});
|
178
apps/server/spec/etapi/create-entities.spec.ts
Normal file
178
apps/server/spec/etapi/create-entities.spec.ts
Normal file
@ -0,0 +1,178 @@
|
|||||||
|
import { Application } from "express";
|
||||||
|
import { beforeAll, describe, expect, it } from "vitest";
|
||||||
|
import supertest from "supertest";
|
||||||
|
import { login } from "./utils.js";
|
||||||
|
import config from "../../src/services/config.js";
|
||||||
|
import { randomInt } from "crypto";
|
||||||
|
|
||||||
|
let app: Application;
|
||||||
|
let token: string;
|
||||||
|
let createdNoteId: string;
|
||||||
|
let createdBranchId: string;
|
||||||
|
let clonedBranchId: string;
|
||||||
|
let createdAttributeId: string;
|
||||||
|
let createdAttachmentId: string;
|
||||||
|
|
||||||
|
const USER = "etapi";
|
||||||
|
|
||||||
|
describe("etapi/create-entities", () => {
|
||||||
|
beforeAll(async () => {
|
||||||
|
config.General.noAuthentication = false;
|
||||||
|
const buildApp = (await (import("../../src/app.js"))).default;
|
||||||
|
app = await buildApp();
|
||||||
|
token = await login(app);
|
||||||
|
|
||||||
|
({ createdNoteId, createdBranchId } = await createNote());
|
||||||
|
clonedBranchId = await createClone();
|
||||||
|
createdAttributeId = await createAttribute();
|
||||||
|
createdAttachmentId = await createAttachment();
|
||||||
|
});
|
||||||
|
|
||||||
|
it("returns note info", async () => {
|
||||||
|
const response = await supertest(app)
|
||||||
|
.get(`/etapi/notes/${createdNoteId}`)
|
||||||
|
.auth(USER, token, { "type": "basic"})
|
||||||
|
.send({
|
||||||
|
noteId: createdNoteId,
|
||||||
|
parentNoteId: "_hidden"
|
||||||
|
})
|
||||||
|
.expect(200);
|
||||||
|
expect(response.body).toMatchObject({
|
||||||
|
noteId: createdNoteId,
|
||||||
|
title: "Hello"
|
||||||
|
});
|
||||||
|
expect(new Set<string>(response.body.parentBranchIds))
|
||||||
|
.toStrictEqual(new Set<string>([ clonedBranchId, createdBranchId ]));
|
||||||
|
});
|
||||||
|
|
||||||
|
it("obtains note content", async () => {
|
||||||
|
await supertest(app)
|
||||||
|
.get(`/etapi/notes/${createdNoteId}/content`)
|
||||||
|
.auth(USER, token, { "type": "basic"})
|
||||||
|
.expect(200)
|
||||||
|
.expect("Hi there!");
|
||||||
|
});
|
||||||
|
|
||||||
|
it("obtains created branch information", async () => {
|
||||||
|
const response = await supertest(app)
|
||||||
|
.get(`/etapi/branches/${createdBranchId}`)
|
||||||
|
.auth(USER, token, { "type": "basic"})
|
||||||
|
.expect(200);
|
||||||
|
expect(response.body).toMatchObject({
|
||||||
|
branchId: createdBranchId,
|
||||||
|
parentNoteId: "root"
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
it("obtains cloned branch information", async () => {
|
||||||
|
const response = await supertest(app)
|
||||||
|
.get(`/etapi/branches/${clonedBranchId}`)
|
||||||
|
.auth(USER, token, { "type": "basic"})
|
||||||
|
.expect(200);
|
||||||
|
expect(response.body).toMatchObject({
|
||||||
|
branchId: clonedBranchId,
|
||||||
|
parentNoteId: "_hidden"
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
it("obtains attribute information", async () => {
|
||||||
|
const response = await supertest(app)
|
||||||
|
.get(`/etapi/attributes/${createdAttributeId}`)
|
||||||
|
.auth(USER, token, { "type": "basic"})
|
||||||
|
.expect(200);
|
||||||
|
expect(response.body.attributeId).toStrictEqual(createdAttributeId);
|
||||||
|
});
|
||||||
|
|
||||||
|
it("obtains attachment information", async () => {
|
||||||
|
const response = await supertest(app)
|
||||||
|
.get(`/etapi/attachments/${createdAttachmentId}`)
|
||||||
|
.auth(USER, token, { "type": "basic"})
|
||||||
|
.expect(200);
|
||||||
|
expect(response.body.attachmentId).toStrictEqual(createdAttachmentId);
|
||||||
|
expect(response.body).toMatchObject({
|
||||||
|
role: "file",
|
||||||
|
mime: "plain/text",
|
||||||
|
title: "my attachment"
|
||||||
|
});
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
async function createNote() {
|
||||||
|
const noteId = `forcedId${randomInt(1000)}`;
|
||||||
|
const response = await supertest(app)
|
||||||
|
.post("/etapi/create-note")
|
||||||
|
.auth(USER, token, { "type": "basic"})
|
||||||
|
.send({
|
||||||
|
"noteId": noteId,
|
||||||
|
"parentNoteId": "root",
|
||||||
|
"title": "Hello",
|
||||||
|
"type": "text",
|
||||||
|
"content": "Hi there!",
|
||||||
|
"dateCreated": "2023-08-21 23:38:51.123+0200",
|
||||||
|
"utcDateCreated": "2023-08-21 23:38:51.123Z"
|
||||||
|
})
|
||||||
|
.expect(201);
|
||||||
|
expect(response.body.note.noteId).toStrictEqual(noteId);
|
||||||
|
expect(response.body).toMatchObject({
|
||||||
|
note: {
|
||||||
|
noteId,
|
||||||
|
title: "Hello",
|
||||||
|
dateCreated: "2023-08-21 23:38:51.123+0200",
|
||||||
|
utcDateCreated: "2023-08-21 23:38:51.123Z"
|
||||||
|
},
|
||||||
|
branch: {
|
||||||
|
parentNoteId: "root"
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
return {
|
||||||
|
createdNoteId: response.body.note.noteId,
|
||||||
|
createdBranchId: response.body.branch.branchId
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
async function createClone() {
|
||||||
|
const response = await supertest(app)
|
||||||
|
.post("/etapi/branches")
|
||||||
|
.auth(USER, token, { "type": "basic"})
|
||||||
|
.send({
|
||||||
|
noteId: createdNoteId,
|
||||||
|
parentNoteId: "_hidden"
|
||||||
|
})
|
||||||
|
.expect(201);
|
||||||
|
expect(response.body.parentNoteId).toStrictEqual("_hidden");
|
||||||
|
return response.body.branchId;
|
||||||
|
}
|
||||||
|
|
||||||
|
async function createAttribute() {
|
||||||
|
const attributeId = `forcedId${randomInt(1000)}`;
|
||||||
|
const response = await supertest(app)
|
||||||
|
.post("/etapi/attributes")
|
||||||
|
.auth(USER, token, { "type": "basic"})
|
||||||
|
.send({
|
||||||
|
"attributeId": attributeId,
|
||||||
|
"noteId": createdNoteId,
|
||||||
|
"type": "label",
|
||||||
|
"name": "mylabel",
|
||||||
|
"value": "val",
|
||||||
|
"isInheritable": true
|
||||||
|
})
|
||||||
|
.expect(201);
|
||||||
|
expect(response.body.attributeId).toStrictEqual(attributeId);
|
||||||
|
return response.body.attributeId;
|
||||||
|
}
|
||||||
|
|
||||||
|
async function createAttachment() {
|
||||||
|
const response = await supertest(app)
|
||||||
|
.post("/etapi/attachments")
|
||||||
|
.auth(USER, token, { "type": "basic"})
|
||||||
|
.send({
|
||||||
|
"ownerId": createdNoteId,
|
||||||
|
"role": "file",
|
||||||
|
"mime": "plain/text",
|
||||||
|
"title": "my attachment",
|
||||||
|
"content": "my text"
|
||||||
|
})
|
||||||
|
.expect(201);
|
||||||
|
return response.body.attachmentId;
|
||||||
|
}
|
54
apps/server/spec/etapi/no-token.spec.ts
Normal file
54
apps/server/spec/etapi/no-token.spec.ts
Normal file
@ -0,0 +1,54 @@
|
|||||||
|
import { Application } from "express";
|
||||||
|
import { beforeAll, describe, expect, it } from "vitest";
|
||||||
|
import supertest from "supertest";
|
||||||
|
import { login } from "./utils.js";
|
||||||
|
import config from "../../src/services/config.js";
|
||||||
|
import type TestAgent from "supertest/lib/agent.js";
|
||||||
|
|
||||||
|
let app: Application;
|
||||||
|
|
||||||
|
const USER = "etapi";
|
||||||
|
|
||||||
|
const routes = [
|
||||||
|
"GET /etapi/notes?search=aaa",
|
||||||
|
"GET /etapi/notes/root",
|
||||||
|
"PATCH /etapi/notes/root",
|
||||||
|
"DELETE /etapi/notes/root",
|
||||||
|
"GET /etapi/branches/root",
|
||||||
|
"PATCH /etapi/branches/root",
|
||||||
|
"DELETE /etapi/branches/root",
|
||||||
|
"GET /etapi/attributes/000",
|
||||||
|
"PATCH /etapi/attributes/000",
|
||||||
|
"DELETE /etapi/attributes/000",
|
||||||
|
"GET /etapi/inbox/2022-02-22",
|
||||||
|
"GET /etapi/calendar/days/2022-02-22",
|
||||||
|
"GET /etapi/calendar/weeks/2022-02-22",
|
||||||
|
"GET /etapi/calendar/months/2022-02",
|
||||||
|
"GET /etapi/calendar/years/2022",
|
||||||
|
"POST /etapi/create-note",
|
||||||
|
"GET /etapi/app-info",
|
||||||
|
]
|
||||||
|
|
||||||
|
describe("no-token", () => {
|
||||||
|
beforeAll(async () => {
|
||||||
|
config.General.noAuthentication = false;
|
||||||
|
const buildApp = (await (import("../../src/app.js"))).default;
|
||||||
|
app = await buildApp();
|
||||||
|
});
|
||||||
|
|
||||||
|
for (const route of routes) {
|
||||||
|
const [ method, url ] = route.split(" ", 2);
|
||||||
|
|
||||||
|
it(`rejects access to ${method} ${url}`, () => {
|
||||||
|
(supertest(app)[method.toLowerCase()](url) as TestAgent)
|
||||||
|
.auth(USER, "fakeauth", { "type": "basic"})
|
||||||
|
.expect(401)
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
it("responds with 404 even without token", () => {
|
||||||
|
supertest(app)
|
||||||
|
.get("/etapi/zzzzzz")
|
||||||
|
.expect(404);
|
||||||
|
});
|
||||||
|
});
|
26
apps/server/spec/etapi/other.spec.ts
Normal file
26
apps/server/spec/etapi/other.spec.ts
Normal file
@ -0,0 +1,26 @@
|
|||||||
|
import { Application } from "express";
|
||||||
|
import { beforeAll, describe, expect, it } from "vitest";
|
||||||
|
import supertest from "supertest";
|
||||||
|
import { login } from "./utils.js";
|
||||||
|
import config from "../../src/services/config.js";
|
||||||
|
|
||||||
|
let app: Application;
|
||||||
|
let token: string;
|
||||||
|
|
||||||
|
const USER = "etapi";
|
||||||
|
|
||||||
|
describe("etapi/refresh-note-ordering/root", () => {
|
||||||
|
beforeAll(async () => {
|
||||||
|
config.General.noAuthentication = false;
|
||||||
|
const buildApp = (await (import("../../src/app.js"))).default;
|
||||||
|
app = await buildApp();
|
||||||
|
token = await login(app);
|
||||||
|
});
|
||||||
|
|
||||||
|
it("refreshes note ordering", async () => {
|
||||||
|
await supertest(app)
|
||||||
|
.post("/etapi/refresh-note-ordering/root")
|
||||||
|
.auth(USER, token, { "type": "basic"})
|
||||||
|
.expect(200);
|
||||||
|
});
|
||||||
|
});
|
40
apps/server/spec/etapi/search.spec.ts
Normal file
40
apps/server/spec/etapi/search.spec.ts
Normal file
@ -0,0 +1,40 @@
|
|||||||
|
import { Application } from "express";
|
||||||
|
import { beforeAll, describe, expect, it } from "vitest";
|
||||||
|
import supertest from "supertest";
|
||||||
|
import { createNote, login } from "./utils.js";
|
||||||
|
import config from "../../src/services/config.js";
|
||||||
|
import { randomUUID } from "crypto";
|
||||||
|
|
||||||
|
let app: Application;
|
||||||
|
let token: string;
|
||||||
|
|
||||||
|
const USER = "etapi";
|
||||||
|
let content: string;
|
||||||
|
|
||||||
|
describe("etapi/search", () => {
|
||||||
|
beforeAll(async () => {
|
||||||
|
config.General.noAuthentication = false;
|
||||||
|
const buildApp = (await (import("../../src/app.js"))).default;
|
||||||
|
app = await buildApp();
|
||||||
|
token = await login(app);
|
||||||
|
|
||||||
|
content = randomUUID();
|
||||||
|
await createNote(app, token, content);
|
||||||
|
});
|
||||||
|
|
||||||
|
it("finds by content", async () => {
|
||||||
|
const response = await supertest(app)
|
||||||
|
.get(`/etapi/notes?search=${content}&debug=true`)
|
||||||
|
.auth(USER, token, { "type": "basic"})
|
||||||
|
.expect(200);
|
||||||
|
expect(response.body.results).toHaveLength(1);
|
||||||
|
});
|
||||||
|
|
||||||
|
it("does not find by content when fast search is on", async () => {
|
||||||
|
const response = await supertest(app)
|
||||||
|
.get(`/etapi/notes?search=${content}&debug=true&fastSearch=true`)
|
||||||
|
.auth(USER, token, { "type": "basic"})
|
||||||
|
.expect(200);
|
||||||
|
expect(response.body.results).toHaveLength(0);
|
||||||
|
});
|
||||||
|
});
|
33
apps/server/spec/etapi/utils.ts
Normal file
33
apps/server/spec/etapi/utils.ts
Normal file
@ -0,0 +1,33 @@
|
|||||||
|
import type { Application } from "express";
|
||||||
|
import supertest from "supertest";
|
||||||
|
import { expect } from "vitest";
|
||||||
|
|
||||||
|
export async function login(app: Application) {
|
||||||
|
// Obtain auth token.
|
||||||
|
const response = await supertest(app)
|
||||||
|
.post("/etapi/auth/login")
|
||||||
|
.send({
|
||||||
|
"password": "demo1234"
|
||||||
|
})
|
||||||
|
.expect(201);
|
||||||
|
const token = response.body.authToken;
|
||||||
|
expect(token).toBeTruthy();
|
||||||
|
return token;
|
||||||
|
}
|
||||||
|
|
||||||
|
export async function createNote(app: Application, token: string, content?: string) {
|
||||||
|
const response = await supertest(app)
|
||||||
|
.post("/etapi/create-note")
|
||||||
|
.auth("etapi", token, { "type": "basic"})
|
||||||
|
.send({
|
||||||
|
"parentNoteId": "root",
|
||||||
|
"title": "Hello",
|
||||||
|
"type": "text",
|
||||||
|
"content": content ?? "Hi there!",
|
||||||
|
})
|
||||||
|
.expect(201);
|
||||||
|
|
||||||
|
const noteId = response.body.note.noteId;
|
||||||
|
expect(noteId).toStrictEqual(noteId);
|
||||||
|
return noteId;
|
||||||
|
}
|
@ -7,6 +7,8 @@ import dayjs from "dayjs";
|
|||||||
process.env.TRILIUM_DATA_DIR = join(__dirname, "db");
|
process.env.TRILIUM_DATA_DIR = join(__dirname, "db");
|
||||||
process.env.TRILIUM_RESOURCE_DIR = join(__dirname, "../src");
|
process.env.TRILIUM_RESOURCE_DIR = join(__dirname, "../src");
|
||||||
process.env.TRILIUM_INTEGRATION_TEST = "memory";
|
process.env.TRILIUM_INTEGRATION_TEST = "memory";
|
||||||
|
process.env.TRILIUM_ENV = "dev";
|
||||||
|
process.env.TRILIUM_PUBLIC_SERVER = "http://localhost:4200";
|
||||||
|
|
||||||
beforeAll(async () => {
|
beforeAll(async () => {
|
||||||
// Initialize the translations manually to avoid any side effects.
|
// Initialize the translations manually to avoid any side effects.
|
||||||
|
@ -10,7 +10,7 @@ export default defineConfig(() => ({
|
|||||||
globals: true,
|
globals: true,
|
||||||
setupFiles: ["./spec/setup.ts"],
|
setupFiles: ["./spec/setup.ts"],
|
||||||
environment: "node",
|
environment: "node",
|
||||||
include: ['{src,tests}/**/*.{test,spec}.{js,mjs,cjs,ts,mts,cts,jsx,tsx}'],
|
include: ['{src,spec}/**/*.{test,spec}.{js,mjs,cjs,ts,mts,cts,jsx,tsx}'],
|
||||||
reporters: ['default'],
|
reporters: ['default'],
|
||||||
coverage: {
|
coverage: {
|
||||||
reportsDirectory: './test-output/vitest/coverage',
|
reportsDirectory: './test-output/vitest/coverage',
|
||||||
|
16
flake.nix
16
flake.nix
@ -27,23 +27,35 @@
|
|||||||
pnpm
|
pnpm
|
||||||
stdenv
|
stdenv
|
||||||
wrapGAppsHook3
|
wrapGAppsHook3
|
||||||
|
xcodebuild
|
||||||
|
darwin
|
||||||
;
|
;
|
||||||
desktop = stdenv.mkDerivation (finalAttrs: {
|
desktop = stdenv.mkDerivation (finalAttrs: {
|
||||||
pname = "triliumnext-desktop";
|
pname = "triliumnext-desktop";
|
||||||
version = packageJSON.version;
|
version = packageJSON.version;
|
||||||
src = lib.cleanSource ./.;
|
src = lib.cleanSource ./.;
|
||||||
|
|
||||||
nativeBuildInputs = [
|
nativeBuildInputs =
|
||||||
|
[
|
||||||
pnpm.configHook
|
pnpm.configHook
|
||||||
nodejs
|
nodejs
|
||||||
nodejs.python
|
nodejs.python
|
||||||
copyDesktopItems
|
copyDesktopItems
|
||||||
makeBinaryWrapper
|
makeBinaryWrapper
|
||||||
wrapGAppsHook3
|
wrapGAppsHook3
|
||||||
|
]
|
||||||
|
++ lib.optionals stdenv.hostPlatform.isDarwin [
|
||||||
|
xcodebuild
|
||||||
|
darwin.cctools
|
||||||
];
|
];
|
||||||
|
|
||||||
dontWrapGApps = true;
|
dontWrapGApps = true;
|
||||||
|
|
||||||
|
preBuild = lib.optionalString stdenv.hostPlatform.isLinux ''
|
||||||
|
patchelf --set-interpreter $(cat $NIX_CC/nix-support/dynamic-linker) \
|
||||||
|
node_modules/.pnpm/sass-embedded-linux-x64@*/node_modules/sass-embedded-linux-x64/dart-sass/src/dart
|
||||||
|
'';
|
||||||
|
|
||||||
buildPhase = ''
|
buildPhase = ''
|
||||||
runHook preBuild
|
runHook preBuild
|
||||||
|
|
||||||
@ -51,8 +63,6 @@
|
|||||||
export NX_TUI=false
|
export NX_TUI=false
|
||||||
export NX_DAEMON=false
|
export NX_DAEMON=false
|
||||||
|
|
||||||
patchelf --set-interpreter $(cat $NIX_CC/nix-support/dynamic-linker) \
|
|
||||||
node_modules/.pnpm/sass-embedded-linux-x64@*/node_modules/sass-embedded-linux-x64/dart-sass/src/dart
|
|
||||||
pnpm nx run desktop:build --outputStyle stream --verbose
|
pnpm nx run desktop:build --outputStyle stream --verbose
|
||||||
|
|
||||||
# Rebuild dependencies
|
# Rebuild dependencies
|
||||||
|
Loading…
x
Reference in New Issue
Block a user