Added eslint

TryGhost · Jul 29, 2024 · baa1e8f · baa1e8f
1 parent e7a4873
commit baa1e8f
Show file tree

Hide file tree

Showing 12 changed files with 730 additions and 167 deletions.
diff --git a/eslint.config.mjs b/eslint.config.mjs
@@ -0,0 +1,11 @@
+// @ts-check
+
+// See https://typescript-eslint.io/getting-started/
+
+import eslint from '@eslint/js';
+import tseslint from 'typescript-eslint';
+
+export default tseslint.config(
+  eslint.configs.recommended,
+  ...tseslint.configs.recommended,
+);
diff --git a/package.json b/package.json
@@ -14,20 +14,24 @@
     "test:code": "c8 --src src --all --reporter text --reporter cobertura mocha -r tsx './src/**/*.test.ts'",
     "test:all": "yarn test:types && yarn test:code",
     "test": "docker compose -f docker-compose.testing.yml up --abort-on-container-exit --exit-code-from activitypub",
-    "lint:code": "eslint *.js lib/ --ext .js --cache",
+    "lint:code": "eslint src/**/*.ts",
     "lint": "yarn lint:code"
   },
   "files": [
     "src"
   ],
   "devDependencies": {
+    "@eslint/js": "9.7.0",
+    "@types/eslint__js": "8.42.3",
     "@types/mocha": "10.0.7",
     "@types/node": "20.12.12",
     "@types/uuid": "10.0.0",
     "c8": "10.1.2",
+    "eslint": "9.7.0",
     "mocha": "10.5.2",
     "tsx": "4.11.0",
-    "typescript": "5.4.5"
+    "typescript": "5.5.4",
+    "typescript-eslint": "7.17.0"
   },
   "dependencies": {
     "@fedify/fedify": "0.12.1",

diff --git a/src/app.ts b/src/app.ts
@@ -2,18 +2,11 @@ import { serve } from '@hono/node-server';
 import {
     Article,
     Accept,
-    Object as ActivityPubObject,
     Federation,
     Follow,
-    KvKey,
     KvStore,
-    MemoryKvStore,
     Create,
     Note,
-    Application,
-    Group,
-    Organization,
-    Service,
     Update,
 } from '@fedify/fedify';
 import { federation } from '@fedify/fedify/x/hono';

diff --git a/src/dispatchers.ts b/src/dispatchers.ts
@@ -44,10 +44,10 @@ export async function handleFollow(
     follow: Follow,
 ) {
     console.log('Handling Follow');
-    if (!follow.id) {
+    if (!follow.id || !follow.objectId) {
         return;
     }
-    const parsed = (ctx as any).parseUri(follow.objectId);
+    const parsed = ctx.parseUri(follow.objectId);
     if (parsed?.type !== 'actor') {
         // TODO Log
         return;
@@ -81,12 +81,15 @@ export async function handleAccept(
     accept: Accept,
 ) {
     console.log('Handling Accept');
-    const parsed = (ctx as any).parseUri(accept.objectId);
-    console.log(parsed);
-    if (false && parsed?.type !== 'follow') {
-        console.log('Not accepting a follow - exit');
+    if (!accept.objectId) {
         return;
     }
+    const parsed = ctx.parseUri(accept.objectId);
+    console.log(parsed);
+    // if (false && parsed?.type !== 'follow') {
+    //     console.log('Not accepting a follow - exit');
+    //     return;
+    // }
     if (!accept.id) {
         console.log('Accept missing id - exit');
         return;
@@ -113,12 +116,18 @@ export async function handleCreate(
     create: Create,
 ) {
     console.log('Handling Create');
-    const parsed = (ctx as any).parseUri(create.objectId);
-    console.log(parsed);
-    if (false && parsed?.type !== 'article') {
-        console.log('Not accepting a follow - exit');
+
+    if (create.objectId === null) {
+        console.log('Create missing objectId - exit');
         return;
     }
+
+    const parsed = ctx.parseUri(create.objectId);
+    console.log(parsed);
+    // if (false && parsed?.type !== 'article') {
+    //     console.log('Not accepting a follow - exit');
+    //     return;
+    // }
     if (!create.id) {
         console.log('Accept missing id - exit');
         return;
@@ -146,12 +155,11 @@ export async function inboxErrorHandler(
 
 export async function followersDispatcher(
     ctx: RequestContext<ContextData>,
-    handle: string,
 ) {
     console.log('Followers Dispatcher');
     const results = (await ctx.data.db.get<string[]>(['followers'])) || [];
     console.log(results);
-    let items: Person[] = [];
+    const items: Person[] = [];
     for (const result of results) {
         try {
             const thing = await lookupObject(result);
@@ -169,20 +177,18 @@ export async function followersDispatcher(
 
 export async function followersCounter(
     ctx: RequestContext<ContextData>,
-    handle: string,
 ) {
     const results = (await ctx.data.db.get<string[]>(['followers'])) || [];
     return results.length;
 }
 
 export async function followingDispatcher(
     ctx: RequestContext<ContextData>,
-    handle: string,
 ) {
     console.log('Following Dispatcher');
     const results = (await ctx.data.db.get<string[]>(['following'])) || [];
     console.log(results);
-    let items: Person[] = [];
+    const items: Person[] = [];
     for (const result of results) {
         try {
             const thing = await lookupObject(result);
@@ -200,20 +206,18 @@ export async function followingDispatcher(
 
 export async function followingCounter(
     ctx: RequestContext<ContextData>,
-    handle: string,
 ) {
     const results = (await ctx.data.db.get<string[]>(['following'])) || [];
     return results.length;
 }
 
 export async function outboxDispatcher(
     ctx: RequestContext<ContextData>,
-    handle: string,
 ) {
     console.log('Outbox Dispatcher');
     const results = (await ctx.data.db.get<string[]>(['outbox'])) || [];
     console.log(results);
-    let items: Activity[] = [];
+    const items: Activity[] = [];
     for (const result of results) {
         try {
             const thing = await ctx.data.globaldb.get([result]);
@@ -230,7 +234,6 @@ export async function outboxDispatcher(
 
 export async function outboxCounter(
     ctx: RequestContext<ContextData>,
-    handle: string,
 ) {
     const results = (await ctx.data.db.get<string[]>(['outbox'])) || [];
     return results.length;

diff --git a/src/dispatchers.unit.test.ts b/src/dispatchers.unit.test.ts
@@ -1,29 +1,12 @@
 import assert from 'assert';
-import {
-    actorDispatcher,
-    keypairDispatcher,
-    handleFollow,
-    inboxErrorHandler,
-    handleAccept,
-    handleCreate,
-    followersDispatcher,
-    followersCounter,
-    followingDispatcher,
-    followingCounter,
-    outboxDispatcher,
-    outboxCounter,
-    articleDispatcher,
-    noteDispatcher,
-    followDispatcher,
-    acceptDispatcher,
-    createDispatcher,
-} from './dispatchers';
 import { RequestContext } from '@fedify/fedify';
+import { ContextData } from './app';
+import { actorDispatcher } from './dispatchers';
 
 describe('dispatchers', function () {
     describe('actorDispatcher', function () {
         it('returns null if the handle is not "index"', async function () {
-            const ctx = {} as RequestContext<any>;
+            const ctx = {} as RequestContext<ContextData>;
             const handle = 'anything';
 
             const actual = await actorDispatcher(ctx, handle);

diff --git a/src/handlers.ts b/src/handlers.ts
@@ -9,7 +9,7 @@ import {
     Update,
     PUBLIC_COLLECTION
 } from '@fedify/fedify';
-import { Context, Next } from 'hono';
+import { Context } from 'hono';
 import ky from 'ky';
 import { v4 as uuidv4 } from 'uuid';
 import { addToList } from './kv-helpers';
@@ -31,6 +31,16 @@ type GhostSiteSettings = {
     }
 }
 
+type Post = {
+    uuid: string;
+    excerpt: string;
+    title: string;
+    html: string;
+    feature_image: string;
+    published_at: string;
+    url: string;
+}
+
 async function getGhostSiteSettings(host: string): Promise<GhostSiteSettings> {
     const settings = await ky
         .get(`https://${host}/ghost/api/admin/site/`)
@@ -45,7 +55,7 @@ async function getGhostSiteSettings(host: string): Promise<GhostSiteSettings> {
     };
 }
 
-async function postToArticle(ctx: RequestContext<ContextData>, post: any) {
+async function postToArticle(ctx: RequestContext<ContextData>, post: Post) {
     if (!post) {
         return {
             article: null,
@@ -61,7 +71,7 @@ async function postToArticle(ctx: RequestContext<ContextData>, post: any) {
         name: post.title,
         content: post.html,
         image: toURL(post.feature_image),
-        published: post.published_at,
+        published: post.published_at as any, /* eslint-disable-line @typescript-eslint/no-explicit-any */
         preview: preview,
         url: toURL(post.url),
     });
@@ -108,7 +118,6 @@ export async function followAction(
 
 export async function postPublishedWebhook(
     ctx: Context<{ Variables: HonoContextVariables }>,
-    next: Next,
 ) {
     // TODO: Validate webhook with secret
     const data = await ctx.req.json();
@@ -155,7 +164,6 @@ export async function postPublishedWebhook(
 
 export async function siteChangedWebhook(
     ctx: Context<{ Variables: HonoContextVariables }>,
-    next: Next,
 ) {
     try {
         // Retrieve site settings from Ghost
@@ -210,10 +218,9 @@ export async function siteChangedWebhook(
 
 export async function inboxHandler(
     ctx: Context<{ Variables: HonoContextVariables }>,
-    next: Next,
 ) {
     const results = (await ctx.get('db').get<string[]>(['inbox'])) || [];
-    let items: unknown[] = [];
+    const items: unknown[] = [];
     for (const result of results) {
         try {
             const thing = await ctx.get('globaldb').get([result]);

diff --git a/src/knex.kvstore.integration.test.ts b/src/knex.kvstore.integration.test.ts
@@ -1,6 +1,5 @@
 import assert from 'assert';
 import { KnexKvStore } from './knex.kvstore';
-import { Knex } from 'knex';
 import { client } from './db';
 
 after(async function () {

diff --git a/src/knex.kvstore.ts b/src/knex.kvstore.ts
@@ -1,4 +1,4 @@
-import { KvKey, KvStore, KvStoreSetOptions } from '@fedify/fedify';
+import { KvKey, KvStore } from '@fedify/fedify';
 import Knex from 'knex';
 
 export class KnexKvStore implements KvStore {
@@ -26,7 +26,7 @@ export class KnexKvStore implements KvStore {
         return row.value;
     }
 
-    async set(key: KvKey, value: unknown, options?: KvStoreSetOptions) {
+    async set(key: KvKey, value: unknown) {
         if (typeof value === 'boolean') {
             value = {
                 '@@BOOLEAN@@': value,

diff --git a/src/kv-helpers.ts b/src/kv-helpers.ts
@@ -10,7 +10,7 @@ export function scopeKvStore(db: KvStore, scope: KvKey): KvStore {
         get(key: KvKey) {
             return db.get(scopeKvKey(scope, key));
         },
-        set(key: KvKey, value: any) {
+        set(key: KvKey, value: unknown) {
             return db.set(scopeKvKey(scope, key), value);
         },
         delete(key: KvKey) {

diff --git a/src/kv-helpers.unit.test.ts b/src/kv-helpers.unit.test.ts
@@ -21,13 +21,15 @@ describe('Kv Helpers', function () {
                 const actual = await scopedStore.get(['key']);
                 const expected = { value: 'da value' };
                 assert.deepEqual(actual, expected);
+                break checkIsSet;
             }
 
             checkDeletes: {
                 await scopedStore.delete(['key']);
                 const actual = await scopedStore.get(['key']);
                 const expected = null;
                 assert.deepEqual(actual, expected);
+                break checkDeletes;
             }
         });
     });
@@ -41,6 +43,7 @@ describe('Kv Helpers', function () {
                 const actual = await store.get(['not-existing']);
                 const expected = ['first'];
                 assert.deepEqual(actual, expected);
+                break checkNonExisting;
             }
 
             checkExisting: {
@@ -49,6 +52,7 @@ describe('Kv Helpers', function () {
                 const actual = await store.get(['existing']);
                 const expected = ['first', 'second'];
                 assert.deepEqual(actual, expected);
+                break checkExisting;
             }
         });
     });
@@ -62,6 +66,7 @@ describe('Kv Helpers', function () {
                 const actual = await store.get(['not-existing']);
                 const expected: never[] = [];
                 assert.deepEqual(actual, expected);
+                break checkNonExisting;
             }
 
             checkExisting: {
@@ -70,6 +75,7 @@ describe('Kv Helpers', function () {
                 const actual = await store.get(['existing']);
                 const expected: never[] = [];
                 assert.deepEqual(actual, expected);
+                break checkExisting;
             }
         });
     });

diff --git a/src/user.ts b/src/user.ts
@@ -62,25 +62,13 @@ export async function getUserData(ctx: RequestContext<ContextData>, handle: stri
         ),
     };
 
-    const dataToStore: PersonData = {
-        id: data.id.href,
-        name: data.name,
-        summary: data.summary,
-        preferredUsername: data.preferredUsername,
-        icon: 'https://ghost.org/favicon.ico',
-        inbox: data.inbox.href,
-        outbox: data.outbox.href,
-        following: data.following.href,
-        followers: data.followers.href,
-    };
-
     await ctx.data.db.set(['handle', handle], data);
 
     return data;
 }
 
 export async function getUserKeypair(ctx: Context<ContextData>, handle: string) {
-    const existing = await ctx.data.db.get<{ publicKey: any; privateKey: any }>([
+    const existing = await ctx.data.db.get<{ publicKey: JsonWebKey; privateKey: JsonWebKey }>([
         'keypair',
         handle,
     ]);