diff --git a/.oxlintrc.json b/.oxlintrc.json index 3091ea0b..86a7d0f4 100644 --- a/.oxlintrc.json +++ b/.oxlintrc.json @@ -124,7 +124,8 @@ "unicorn/max-nested-calls": ["warn", { "max": 5 }], "eslint/require-await": "off", // overlaps with typescript "typescript/ban-types": "off", - "eslint/capitalized-comments": ["warn", "always", { "ignoreConsecutiveComments": true }] + "eslint/capitalized-comments": ["warn", "always", { "ignoreConsecutiveComments": true }], + "unicorn/no-array-reduce": "off" }, "env": { "builtin": true, "browser": true, "vue": true }, "globals": { diff --git a/CHANGELOG.md b/CHANGELOG.md index 6f606775..cd7b6033 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -9,7 +9,7 @@ All notable changes to this project will be documented in this file. - Supported editing module version in the module editor. - Fixed the bug that causes module update button to never show when auto-update is disabled. - Added module management menu item to manually refresh sources. -- Add a loading indicator when module sources are being loaded. +- Added a loading indicator when module sources are being loaded. - Ensured network response headers are always normalized to lowercase. ### WebDAV Module @@ -52,7 +52,7 @@ All notable changes to this project will be documented in this file. - Removed memory control options since it does not have real effect in current Obsidian environment. - Made internal operation optimization capturing more precise and simplified its implementation. - Improved syncing robustness when confronting server rate limits and network fluctuation. -- Improved interval namespace isolation to support double instancing. +- Improved internal namespace isolation to support double instancing. - Improved internal sync operation construction flow. - Improved internal file tree rendering process. diff --git a/docs/src/pages/en/development/develop-a-module.md b/docs/src/pages/en/development/develop-a-module.md index 9fd5584e..ad354d36 100644 --- a/docs/src/pages/en/development/develop-a-module.md +++ b/docs/src/pages/en/development/develop-a-module.md @@ -90,6 +90,7 @@ Passing module metadata to the plugin prepends a magic bytes comment to each com ```TypeScript plugins: [ syncEngineModule({ + id: 'my-module', name: 'My Module', icon: 'puzzle', description: 'An example module.', @@ -104,6 +105,7 @@ The output file then starts with: ```js /*! +id: my-module name: My Module icon: puzzle description: An example module. diff --git a/modules.json b/modules.json index a1b78daf..6eee762e 100644 --- a/modules.json +++ b/modules.json @@ -22,7 +22,7 @@ { "id": "gdrive", "name": "Google Drive", - "version": "1.0.2", + "version": "1.0.3", "description": "Google Drive backend support.", "icon": "server", "main": "https://sync.consensia.cc/modules/gdrive.js", @@ -32,7 +32,7 @@ { "id": "dropbox", "name": "Dropbox", - "version": "0.1.1", + "version": "0.1.2", "description": "[Beta] Dropbox backend support.", "icon": "server", "main": "https://sync.consensia.cc/modules/dropbox.js", diff --git a/packages/dropbox/src/dropbox/auth.ts b/packages/dropbox/src/dropbox/auth.ts index a9b358ee..6d42497f 100644 --- a/packages/dropbox/src/dropbox/auth.ts +++ b/packages/dropbox/src/dropbox/auth.ts @@ -6,7 +6,6 @@ import { requestUrl } from 'obsidian'; import type { Binary, Request, StringKV } from '@hesprs/sync-engine-sdk'; import type { ObsidianProtocolData, SecretStorage } from 'obsidian'; -export const AUTH_ERROR_MESSAGE = 'Please authenticate the Dropbox account!'; export const APP_KEY = atob(process.env.DROPBOX_APP_KEY ?? ''); export const REDIRECT_URI = 'obsidian://sync-engine-dropbox-auth'; export const OAUTH_SCOPE = 'files.content.read files.content.write files.metadata.read'; @@ -121,7 +120,21 @@ export class TokenManager { readonly setRefreshToken = (token: string) => this.secretStorage.setSecret(KEYCHAIN_SECRET_ID, token); - readonly deleteRefreshToken = () => this.secretStorage.deleteSecret(KEYCHAIN_SECRET_ID); + readonly deleteRefreshToken = () => { + const token = this.getRefreshToken(); + if (!token) return; + return this.getToken() + .finally(() => this.secretStorage.deleteSecret(KEYCHAIN_SECRET_ID)) + .then((access) => + requestUrl({ + headers: { Authorization: `Bearer ${access}` }, + method: 'POST', + throw: false, + url: `${API_RPC}/2/auth/token/revoke`, + }), + ) + .catch(() => {}); + }; readonly setToken = (token: string, expiresIn: number): void => { this.accessToken = token; @@ -135,7 +148,7 @@ export class TokenManager { private async refresh(): Promise { const refresh_token = this.getRefreshToken(); - if (!refresh_token) throw new Error(AUTH_ERROR_MESSAGE); + if (!refresh_token) throw new Error('Please authenticate the Dropbox account!'); const response = await requestUrl({ body: formEncode({ client_id: APP_KEY, grant_type: 'refresh_token', refresh_token }), contentType: FORM_CONTENT_TYPE, @@ -168,30 +181,15 @@ export function bearerMiddleware(request: Request, manager: TokenManager): Reque headers: { ...params?.headers, Authorization: `Bearer ${token}` }, }); try { - return await send(await manager.getToken()); + return await manager.getToken().then(send); } catch (error: unknown) { if (getStatus(error) !== 401) throw error; manager.invalidate(); - return send(await manager.getToken(true)); + return manager.getToken(true).then(send); } }; } -/** Revokes the token set derived from the current refresh token. Fire-and-forget. */ -export async function revokeToken(manager: TokenManager): Promise { - try { - const token = await manager.getToken(); - await requestUrl({ - headers: { Authorization: `Bearer ${token}` }, - method: 'POST', - throw: false, - url: `${API_RPC}/2/auth/token/revoke`, - }); - } catch { - // Best-effort; the token also expires on its own. - } -} - /** * Correlates the `obsidian://sync-engine-dropbox-auth` callback with the pending authorization * request; callbacks with mismatched or missing state are ignored. diff --git a/packages/dropbox/src/dropbox/check-connection.ts b/packages/dropbox/src/dropbox/check-connection.ts index 6c98e2d0..14382542 100644 --- a/packages/dropbox/src/dropbox/check-connection.ts +++ b/packages/dropbox/src/dropbox/check-connection.ts @@ -1,14 +1,9 @@ import { rpc } from './api'; -import { AUTH_ERROR_MESSAGE } from './auth'; import { toError } from '@repo/shared/error'; import type { Request } from '@hesprs/sync-engine-sdk'; /** Validates the token by listing the app folder root, the lightest permission-honoring call. */ -export default async function checkConnection( - request: Request, - accountId: string, -): Promise { - if (!accountId) return new Error(AUTH_ERROR_MESSAGE); +export default async function checkConnection(request: Request): Promise { try { await rpc(request, '/2/files/list_folder', { path: '' }); } catch (error) { diff --git a/packages/dropbox/src/dropbox/fs.ts b/packages/dropbox/src/dropbox/fs.ts index 172c907e..cb8af53c 100644 --- a/packages/dropbox/src/dropbox/fs.ts +++ b/packages/dropbox/src/dropbox/fs.ts @@ -12,7 +12,6 @@ import { uidOf, verifyEntries, } from './api'; -import { AUTH_ERROR_MESSAGE } from './auth'; import UploadSessions from './sessions'; import { SESSION_CHUNK_SIZE, appendSession, concurrentUploadSession, read2xx } from './upload'; import { chunkSize, concurrency } from '@hesprs/sync-engine-sdk'; @@ -90,7 +89,6 @@ export default class DropboxFs implements RootFs { private readonly request: Request, private readonly options: DropboxFsOptions, ) { - if (!options.accountId) throw new Error(AUTH_ERROR_MESSAGE); this.uploadSessions = new UploadSessions(request); } diff --git a/packages/dropbox/src/index.ts b/packages/dropbox/src/index.ts index 165ec827..8229cf84 100644 --- a/packages/dropbox/src/index.ts +++ b/packages/dropbox/src/index.ts @@ -78,7 +78,7 @@ export default class Dropbox { cleanup.push( registerCss(styles), registerRemoteFs('dropbox', { - checkConnection: (req) => checkConnection(req, moduleSettings.accountId), + checkConnection, instantiate: (request) => new DropboxFs(request, moduleSettings), prettyName: () => translate('dropbox'), }), @@ -103,6 +103,10 @@ export default class Dropbox { }), registerObsidianProtocolHandler('sync-engine-dropbox-auth', pending.notify), ); + + // The token can exist despite the user ID is missing (e.g. user reinstalled the plugin), force a re-auth to prevent bugs caused by a missing ID + const token = tokenManager.getRefreshToken(); + if (!moduleSettings.accountId && token) void tokenManager.deleteRefreshToken(); }; readonly dispose = () => this.cleanup.splice(0).forEach((fn) => fn()); diff --git a/packages/dropbox/src/setting.ts b/packages/dropbox/src/setting.ts index 5e6310a3..7030c2fc 100644 --- a/packages/dropbox/src/setting.ts +++ b/packages/dropbox/src/setting.ts @@ -1,4 +1,4 @@ -import { exchangeCodeForTokens, revokeToken, startAuthorization } from './dropbox/auth'; +import { exchangeCodeForTokens, startAuthorization } from './dropbox/auth'; import { settingEntry as s } from '@hesprs/sync-engine-sdk'; import { describeError, toError } from '@repo/shared/error'; import { normalizeBaseDir } from '@repo/shared/path'; @@ -158,7 +158,7 @@ export default function dropboxSetting( .onClick(() => connectDropbox()), ); }, - visible: () => !settings.accountId || !tokenManager.getRefreshToken(), + visible: () => !tokenManager.getRefreshToken(), })), 1100: s(() => ({ desc: translate('connectSuccess'), @@ -169,17 +169,17 @@ export default function dropboxSetting( .setButtonText(translate('disconnect')) .setDestructive() .onClick(async () => { - if (!tokenManager.getRefreshToken()) return; - await revokeToken(tokenManager); - settings.accountId = ''; - tokenManager.deleteRefreshToken(); - tokenManager.invalidate(); - void saveSettings(); + if (tokenManager.getRefreshToken()) { + await tokenManager.deleteRefreshToken(); + settings.accountId = ''; + tokenManager.invalidate(); + void saveSettings(); + } refreshSettingTab(); }), ); }, - visible: () => Boolean(tokenManager.getRefreshToken() && settings.accountId), + visible: () => Boolean(tokenManager.getRefreshToken()), })), 2000: s(() => ({ desc: translate('baseDirectoryDescription'), diff --git a/packages/dropbox/test/auth.test.ts b/packages/dropbox/test/auth.test.ts index 059b4c9a..e3e94646 100644 --- a/packages/dropbox/test/auth.test.ts +++ b/packages/dropbox/test/auth.test.ts @@ -1,4 +1,12 @@ import { API_RPC, OAUTH_TOKEN_URL } from '@/dropbox/api'; +import { + APP_KEY, + PendingAuthorization, + TokenManager, + bearerMiddleware, + exchangeCodeForTokens, + startAuthorization, +} from '@/dropbox/auth'; import { testKit } from '@hesprs/sync-engine-sdk/dev'; import ObsidianMock from '@repo/shared/obsidian-mock'; import { expect, mock, test } from 'bun:test'; @@ -25,16 +33,6 @@ void mock.module('obsidian', () => ({ }, })); -const { - APP_KEY, - PendingAuthorization, - TokenManager, - bearerMiddleware, - exchangeCodeForTokens, - revokeToken, - startAuthorization, -} = await import('@/dropbox/auth'); - function reset(...next: Array) { requests.length = 0; responses = [...next]; @@ -174,8 +172,10 @@ test('caches tokens and retries bearer requests after a 401', async () => { test('revokes the current token set derived from the refresh token', async () => { reset({ json: { access_token: 'access', expires_in: 14_400 } }, {}); const manager = new TokenManager(createSecrets()); - await revokeToken(manager); + await manager.deleteRefreshToken(); + + expect(manager.getRefreshToken()).toBeUndefined(); expect(requests[1]?.url).toBe(`${API_RPC}/2/auth/token/revoke`); expect(requests[1]?.headers?.Authorization).toBe('Bearer access'); }); diff --git a/packages/dropbox/test/fs-dropbox.test.ts b/packages/dropbox/test/fs-dropbox.test.ts index 00d0b284..1c79f689 100644 --- a/packages/dropbox/test/fs-dropbox.test.ts +++ b/packages/dropbox/test/fs-dropbox.test.ts @@ -1128,7 +1128,7 @@ test('the commit-ready callback reports ready writes until cleared', async () => test('checkConnection validates the token through a root listing', async () => { const failing = createFs(() => json({ error: { '.tag': 'invalid_access_token' } }, 401)); - const failure = await checkConnection(failing.request, 'id'); + const failure = await checkConnection(failing.request); expect(failure).toBeInstanceOf(Error); expect(String(failure)).toContain('invalid_access_token'); @@ -1136,5 +1136,5 @@ test('checkConnection validates the token through a root listing', async () => { expect(url).toBe(`${API_RPC}/2/files/list_folder`); return json({ cursor: '', entries: [], has_more: false }); }); - expect(await checkConnection(passing.request, 'id')).toBeUndefined(); + expect(await checkConnection(passing.request)).toBeUndefined(); }); diff --git a/packages/encryption/src/wrapper/index.ts b/packages/encryption/src/wrapper/index.ts index 7f5efbae..536b3085 100644 --- a/packages/encryption/src/wrapper/index.ts +++ b/packages/encryption/src/wrapper/index.ts @@ -119,8 +119,8 @@ class EncryptionFs implements WrappedFs { ); } - async delete(key: string) { - return this.original.delete(await this.encryptKey(key)); + delete(key: string) { + return this.encryptKey(key).then((enc) => this.original.delete(enc)); } async move(oldKey: string, newKey: string) { @@ -142,7 +142,7 @@ class EncryptionFs implements WrappedFs { } async stat(key: string) { - const stat = await this.original.stat(await this.encryptKey(key)); + const stat = await this.encryptKey(key).then((enc) => this.original.stat(enc)); stat.key = await this.decryptKey(stat.key); if (stat.isDir) return stat; const { metaKey } = await this.getKeys(); @@ -151,8 +151,8 @@ class EncryptionFs implements WrappedFs { return stat; } - async exists(key: string): Promise { - return this.original.exists(await this.encryptKey(key)); + exists(key: string): Promise { + return this.encryptKey(key).then((enc) => this.original.exists(enc)); } async list(key: string, reporter: ListReporter) { diff --git a/packages/encryption/src/wrapper/read-stream.ts b/packages/encryption/src/wrapper/read-stream.ts index 91521708..621ec29c 100644 --- a/packages/encryption/src/wrapper/read-stream.ts +++ b/packages/encryption/src/wrapper/read-stream.ts @@ -51,7 +51,9 @@ export default function createDecryptedReadableStream( const encryptedChunk = pending.slice(expectedSize); controller.enqueue( - await decryptContentChunk(await fileKeyPromise, encryptedChunk, chunkIndex), + await fileKeyPromise.then((fk) => + decryptContentChunk(fk, encryptedChunk, chunkIndex), + ), ); chunkIndex += 1; } diff --git a/packages/gdrive/src/gdrive/api.ts b/packages/gdrive/src/gdrive/api.ts index b161dadd..54ca2bf1 100644 --- a/packages/gdrive/src/gdrive/api.ts +++ b/packages/gdrive/src/gdrive/api.ts @@ -78,3 +78,9 @@ export function toStat( uid: md5Checksum ?? `${mtime}~${size}`, }; } + +export function getFileUid(file: DriveFile, key: string) { + const stat = toStat(key, file); + if (stat.isDir) throw new Error(`Google Drive write returned a folder stat for ${key}.`); + return stat.uid; +} diff --git a/packages/gdrive/src/gdrive/auth.ts b/packages/gdrive/src/gdrive/auth.ts index b75315ce..fe90cbe4 100644 --- a/packages/gdrive/src/gdrive/auth.ts +++ b/packages/gdrive/src/gdrive/auth.ts @@ -10,7 +10,6 @@ import { getStatus } from '@repo/shared/error'; import { Platform, requestUrl, SecretStorage } from 'obsidian'; import type { Request, StringKV } from '@hesprs/sync-engine-sdk'; -export const AUTH_ERROR_MESSAGE = 'Please authenticate the Google Account!'; export const CLIENT_ID = atob(process.env.CLIENT_ID ?? ''); export const CLIENT_SECRET = atob(process.env.CLIENT_SECRET ?? ''); // Not really a secret const KEYCHAIN_SECRET_ID = 'sync-engine-gdrive-refresh-token'; // Secret storage id under which the Google refresh token is stored. @@ -171,16 +170,6 @@ function extractSub(idToken: string): string { return payload.sub; } -// Fire-and-forget revocation -export function revokeToken(token: string) { - return requestUrl({ - contentType: FORM_CONTENT_TYPE, - method: 'POST', - throw: false, - url: buildUrl(TOKEN_REVOKE_URL, '', { token }), - }).catch(() => {}); -} - /** * Caches the short-lived access token and refreshes it with the stored refresh token when needed. * One instance is shared by the request middleware and the connection check so a token refresh @@ -205,7 +194,17 @@ export class TokenManager { readonly setRefreshToken = (token: string) => this.secretStorage.setSecret(KEYCHAIN_SECRET_ID, token); - readonly deleteRefreshToken = () => this.secretStorage.deleteSecret(KEYCHAIN_SECRET_ID); + readonly deleteRefreshToken = () => { + const token = this.getRefreshToken(); + if (!token) return; + this.secretStorage.deleteSecret(KEYCHAIN_SECRET_ID); + return requestUrl({ + contentType: FORM_CONTENT_TYPE, + method: 'POST', + throw: false, + url: buildUrl(TOKEN_REVOKE_URL, '', { token }), + }).catch(() => {}); + }; readonly setToken = (token: string, expiresIn: number) => { this.accessToken = token; @@ -219,7 +218,7 @@ export class TokenManager { private async refresh(): Promise { const refresh_token = this.getRefreshToken(); - if (!refresh_token) throw new Error(AUTH_ERROR_MESSAGE); + if (!refresh_token) throw new Error('Please authenticate the Google Account!'); const response = await requestUrl({ body: formEncode({ client_id: CLIENT_ID, @@ -258,11 +257,11 @@ export function bearerMiddleware(request: Request, manager: TokenManager): Reque headers: { ...params?.headers, Authorization: `Bearer ${token}` }, }); try { - return await send(await manager.getToken()); + return await manager.getToken().then(send); } catch (error: unknown) { if (getStatus(error) !== 401) throw error; manager.invalidate(); - return send(await manager.getToken(true)); + return manager.getToken(true).then(send); } }; } diff --git a/packages/gdrive/src/gdrive/check-connection.ts b/packages/gdrive/src/gdrive/check-connection.ts index e3cfd414..6be7114a 100644 --- a/packages/gdrive/src/gdrive/check-connection.ts +++ b/packages/gdrive/src/gdrive/check-connection.ts @@ -1,13 +1,8 @@ import { DRIVE_API, buildUrl, parseDriveError } from './api'; -import { AUTH_ERROR_MESSAGE } from './auth'; import { toError } from '@repo/shared/error'; import type { Request } from '@hesprs/sync-engine-sdk'; -export default async function checkConnection( - request: Request, - userId: string, -): Promise { - if (!userId) return new Error(AUTH_ERROR_MESSAGE); +export default async function checkConnection(request: Request): Promise { try { const response = await request(buildUrl(DRIVE_API, '/about', { fields: 'storageQuota' }), { method: 'GET', diff --git a/packages/gdrive/src/gdrive/fs.ts b/packages/gdrive/src/gdrive/fs.ts index 59932412..33c16a45 100644 --- a/packages/gdrive/src/gdrive/fs.ts +++ b/packages/gdrive/src/gdrive/fs.ts @@ -5,10 +5,10 @@ import { FOLDER_MIME, buildUrl, escapeQuery, + getFileUid, parseDriveError, toStat, } from './api'; -import { AUTH_ERROR_MESSAGE } from './auth'; import { guessMimeType, resumableUpload, singleUpload } from './upload'; import { chunkSize, concurrency } from '@hesprs/sync-engine-sdk'; import { textToUint8Array } from '@repo/shared/binary'; @@ -63,7 +63,6 @@ export default class GdriveFs implements RootFs { private readonly options: GdriveFsOptions, memoryDB: GdriveDB, ) { - if (!options.userId) throw new Error(AUTH_ERROR_MESSAGE); this.ids = memoryDB.getStore('gdriveIds'); if (memoryDB.getMeta('gdriveIdsMarker') !== this.getUid()) { this.ids.clear(); @@ -193,16 +192,15 @@ export default class GdriveFs implements RootFs { } async write(key: string, value: MaybePromise, stat: FileStat): Promise { - const file = await singleUpload( - { - ...(await this.uploadTarget(key, stat, 'multipart')), - mimeType: guessMimeType(basename(key)), - request: this.request, - }, - await value, + const file = await Promise.all([this.uploadTarget(key, stat, 'multipart'), value]).then( + ([targets, val]) => + singleUpload( + { ...targets, mimeType: guessMimeType(basename(key)), request: this.request }, + val, + ), ); - if (file.id) this.ids.set(key, file.id); - return file.md5Checksum ?? `${stat.mtime}~${stat.size}`; + this.ids.set(key, file.id); + return getFileUid(file, key); } async writeStream( @@ -210,16 +208,12 @@ export default class GdriveFs implements RootFs { value: MaybePromise>, stat: FileStat, ): Promise { - const file = await resumableUpload( - { - ...(await this.uploadTarget(key, stat, 'resumable')), - request: this.request, - size: stat.size, - }, - await value, + const file = await Promise.all([this.uploadTarget(key, stat, 'resumable'), value]).then( + ([targets, val]) => + resumableUpload({ ...targets, request: this.request, size: stat.size }, val), ); - if (file.id) this.ids.set(key, file.id); - return file.md5Checksum ?? `${stat.mtime}~${stat.size}`; + this.ids.set(key, file.id); + return getFileUid(file, key); } async delete(key: string): Promise { @@ -313,9 +307,9 @@ export default class GdriveFs implements RootFs { return toStat(key, entry); } - async exists(key: string): Promise { + exists(key: string): Promise { // When Sync Engine calls `exists()`, the only possibility is that something unexpected happened, don't trust cache here - return (await this.resolveIdFresh(key)) !== undefined; + return this.resolveIdFresh(key).then((id) => id !== undefined); } /** diff --git a/packages/gdrive/src/index.ts b/packages/gdrive/src/index.ts index bd615e1d..63bd43fe 100644 --- a/packages/gdrive/src/index.ts +++ b/packages/gdrive/src/index.ts @@ -68,7 +68,7 @@ export default class Gdrive { cleanup.push( registerCss(styles), registerRemoteFs('gdrive', { - checkConnection: (req) => checkConnection(req, moduleSettings.userId), + checkConnection, instantiate: (request) => new GdriveFs(request, moduleSettings, memoryDB), prettyName: () => translate('gdrive'), }), @@ -91,6 +91,10 @@ export default class Gdrive { priority: 683, }), ); + + // The token can exist despite the user ID is missing (e.g. user reinstalled the plugin), force a re-auth to prevent bugs caused by a missing ID + const token = tokenManager.getRefreshToken(); + if (!moduleSettings.userId && token) void tokenManager.deleteRefreshToken(); }; readonly dispose = () => { diff --git a/packages/gdrive/src/setting.ts b/packages/gdrive/src/setting.ts index 482d7ed9..d56f501a 100644 --- a/packages/gdrive/src/setting.ts +++ b/packages/gdrive/src/setting.ts @@ -1,4 +1,4 @@ -import { pollDeviceToken, revokeToken, startDeviceAuthorization } from './gdrive/auth'; +import { pollDeviceToken, startDeviceAuthorization } from './gdrive/auth'; import { settingEntry as s } from '@hesprs/sync-engine-sdk'; import { describeError, toError } from '@repo/shared/error'; import { normalizeBaseDir } from '@repo/shared/path'; @@ -168,7 +168,7 @@ export default function gdriveSetting( ), ); }, - visible: () => !settings.userId || !tokenManager.getRefreshToken(), + visible: () => !tokenManager.getRefreshToken(), })), 1100: s(() => ({ desc: translate('connectSuccess'), @@ -179,18 +179,17 @@ export default function gdriveSetting( .setButtonText(translate('disconnect')) .setDestructive() .onClick(async () => { - const token = tokenManager.getRefreshToken(); - if (!token) return; - await revokeToken(token); - settings.userId = ''; - tokenManager.deleteRefreshToken(); - tokenManager.invalidate(); - void saveSettings(); + if (tokenManager.getRefreshToken()) { + await tokenManager.deleteRefreshToken(); + settings.userId = ''; + tokenManager.invalidate(); + void saveSettings(); + } refreshSettingTab(); }), ); }, - visible: () => Boolean(tokenManager.getRefreshToken() && settings.userId), + visible: () => Boolean(tokenManager.getRefreshToken()), })), 2000: s(() => ({ desc: translate('baseDirectoryDescription'), diff --git a/packages/gdrive/test/auth.test.ts b/packages/gdrive/test/auth.test.ts index f6416948..653660ae 100644 --- a/packages/gdrive/test/auth.test.ts +++ b/packages/gdrive/test/auth.test.ts @@ -1,3 +1,9 @@ +import { + TokenManager, + bearerMiddleware, + pollDeviceToken, + startDeviceAuthorization, +} from '@/gdrive/auth'; import { testKit } from '@hesprs/sync-engine-sdk/dev'; import ObsidianMock from '@repo/shared/obsidian-mock'; import { expect, mock, test } from 'bun:test'; @@ -21,9 +27,6 @@ void mock.module('obsidian', () => ({ }, })); -const { TokenManager, bearerMiddleware, pollDeviceToken, startDeviceAuthorization } = - await import('@/gdrive/auth'); - const GRANTED_SCOPE = 'https://www.googleapis.com/auth/drive.file openid'; function reset(...next: Array) { diff --git a/packages/plugin/dist/tsdown-plugin.spec.d.ts b/packages/plugin/dist/tsdown-plugin.spec.d.ts index 7955caf8..20dde9fe 100644 --- a/packages/plugin/dist/tsdown-plugin.spec.d.ts +++ b/packages/plugin/dist/tsdown-plugin.spec.d.ts @@ -3,11 +3,9 @@ type SyncEngineConfig = { neverBundle?: true | string | RegExp | Array | ((id: string, parentId: string | undefined, isResolved: boolean) => boolean | null | undefined); }; }; -type ModuleMeta = Partial>; -type ModuleMetaWithId = ModuleMeta & { - id: string; -}; -export default function syncEngineModule(meta?: ModuleMeta | Array | Record): { +type ModuleMeta = Partial>; +type MetaOption = ModuleMeta | Array | Record; +export default function syncEngineModule(meta?: MetaOption): { name: string; renderChunk(code: string, chunk: { name: string; diff --git a/packages/plugin/src/components/ModuleEditorModal.ts b/packages/plugin/src/components/ModuleEditorModal.ts index abdc3049..3942e934 100644 --- a/packages/plugin/src/components/ModuleEditorModal.ts +++ b/packages/plugin/src/components/ModuleEditorModal.ts @@ -72,7 +72,7 @@ export default class ModuleEditorModal extends Modal { description: description || magic.description || 'An unknown module.', enabled, icon: icon || magic.icon || 'puzzle', - id: id || name || magic.name || crypto.randomUUID(), + id: id || magic.id || name || magic.name || crypto.randomUUID(), integrity, main, name: name || magic.name || 'Unknown Module', diff --git a/packages/plugin/src/components/module-management/App.tsx b/packages/plugin/src/components/module-management/App.tsx index 8c62ab0e..9ce1d480 100644 --- a/packages/plugin/src/components/module-management/App.tsx +++ b/packages/plugin/src/components/module-management/App.tsx @@ -4,6 +4,7 @@ import Card from './Card'; import { MODULE_EXTENSION } from '@/modules/Extensibility'; import { Menu, prepareFuzzySearch, SearchComponent, Notice, ExtraButtonComponent } from 'obsidian'; import { For, Show, createEffect, createMemo, createSignal, onMount } from 'solid-js'; +import { compare } from 'verkit'; import type { ModuleManagementContext, PendingAction } from './index'; import type { AugmentedModuleMeta } from '@/modules/Extensibility'; import type { MaybePromise } from '@/types'; @@ -11,13 +12,19 @@ import type { MenuItem, SearchResult } from 'obsidian'; const ALTERNATIVE_MODULE_EXTENSION = '.mjs'; +type MergedMeta = { + canonical: AugmentedModuleMeta; + installed?: AugmentedModuleMeta; + upstream?: AugmentedModuleMeta; +}; + export default function App(props: { el: Element; ctx: ModuleManagementContext; isUnmounted: () => boolean; }) { const t = props.ctx.translate; - const [sourceModules, setSourceModules] = createSignal(new Map()); + const [sourceModules, setSourceModules] = createSignal>([]); const [installedModules, setInstalledModules] = createSignal(props.ctx.discoveredModules, { equals: () => false, }); @@ -41,16 +48,7 @@ export default function App(props: { if (props.isUnmounted() || isLoading()) return; setIsLoading(true); try { - const seen = new Set(); - const modules = new Map( - (await props.ctx.fetchSources(manual)) - .filter(({ id }) => { - if (seen.has(id)) return false; - seen.add(id); - return true; - }) - .map((module) => [module.id, module]), - ); + const modules = await props.ctx.fetchSources(manual); if (props.isUnmounted()) return; setSourceModules(modules); syncSnapshots(); @@ -61,32 +59,58 @@ export default function App(props: { } }; - const mergedModules = createMemo>(() => [ - ...new Set([...sourceModules().keys(), ...installedModules().keys()]), - ]); - - const getCanonicalMeta = (id: string) => - (installedModules().get(id) ?? sourceModules().get(id)) as AugmentedModuleMeta; + const mergedModules = createMemo>(() => { + const sourceMap = new Map>(); + const installedMeta = installedModules(); + for (const module of sourceModules()) { + let existing = sourceMap.get(module.id); + if (!existing) { + existing = []; + sourceMap.set(module.id, existing); + } + existing.push(module); + } + const result: Record = {}; + const ids = new Set([...sourceMap.keys(), ...installedMeta.keys()]); + for (const id of ids) { + const installed = installedMeta.get(id); + const sourceMapModules = sourceMap.get(id); + const upstream = sourceMapModules + ? installed + ? sourceMapModules.find(({ source }) => source === installed.source) + : sourceMapModules.reduce((max, cur) => + compare(cur.version, max.version) === 1 ? cur : max, + ) + : undefined; + const canonical = (installed ?? upstream) as AugmentedModuleMeta; + result[id] = { canonical, installed, upstream }; + } + return result; + }); - const visibleModules = createMemo>(() => { - const normalizedQuery = query().trim(); - const filtered = mergedModules().filter((id) => { + const visibleModules = createMemo>(() => { + const filtered = Object.entries(mergedModules()).filter(([id]) => { if (!showInstalledOnly()) return true; return installedModules().has(id); }); - if (!normalizedQuery) return filtered.sort((a, b) => a.localeCompare(b)); - + const normalizedQuery = query().trim(); + if (!normalizedQuery) return new Map(filtered.sort(([a], [b]) => a.localeCompare(b))); const match = prepareFuzzySearch(normalizedQuery); - return filtered - .map(getCanonicalMeta) - .map((module) => ({ module, score: getModuleScore(match, module) })) - .filter( - (entry): entry is { module: AugmentedModuleMeta; score: number } => - entry.score !== undefined, - ) - .sort((a, b) => b.score - a.score || a.module.id.localeCompare(b.module.id)) - .map(({ module: { id } }) => id); + return new Map( + filtered + .map((entry) => ({ entry, score: getModuleScore(match, entry[1].canonical) })) + .filter( + (entry): entry is { entry: [string, MergedMeta]; score: number } => + entry.score !== undefined, + ) + .sort( + (a, b) => + b.score - a.score || + a.entry[1].canonical.id.localeCompare(b.entry[1].canonical.id), + ) + .map(({ entry }) => entry), + ); }); const runAction = async (id: string, action: PendingAction, op: () => MaybePromise) => { @@ -190,7 +214,7 @@ export default function App(props: { />
0} + when={visibleModules().size} fallback={
{getEmptyStateText({ @@ -210,20 +234,23 @@ export default function App(props: { 'repeat(auto-fit, minmax(min(260px, 100%), 1fr))', }} > - - {(id) => ( - { - void runAction(id, action, op); - }} - /> - )} + + {(id) => { + const get = () => visibleModules().get(id) as MergedMeta; + return ( + { + void runAction(id, action, op); + }} + /> + ); + }}
diff --git a/packages/plugin/src/components/module-management/Card.tsx b/packages/plugin/src/components/module-management/Card.tsx index 3d7b2dcb..e09e6247 100644 --- a/packages/plugin/src/components/module-management/Card.tsx +++ b/packages/plugin/src/components/module-management/Card.tsx @@ -18,22 +18,22 @@ export default function Card(props: { | 'updateModuleMeta' | 'app' >; - sourceMeta?: AugmentedModuleMeta; + upstream?: AugmentedModuleMeta; canonical: AugmentedModuleMeta; isLoaded: boolean; - installedMeta?: AugmentedModuleMeta; + installed?: AugmentedModuleMeta; pendingAction?: PendingAction; runAction: (action: PendingAction, op: () => MaybePromise) => void; }) { - const isInstalled = () => Boolean(props.installedMeta); + const isInstalled = () => Boolean(props.installed); const hasUpdate = () => - props.sourceMeta && - props.installedMeta && - compare(props.sourceMeta.version, props.installedMeta.version) === 1; + props.upstream && + props.installed && + compare(props.upstream.version, props.installed.version) === 1; const busy = () => props.pendingAction !== undefined; const versionLabel = () => { if (hasUpdate()) - return `v${(props.installedMeta as AugmentedModuleMeta).version}\u00A0\u00A0→\u00A0\u00A0v${(props.sourceMeta as AugmentedModuleMeta).version}`; + return `v${(props.installed as AugmentedModuleMeta).version}\u00A0\u00A0→\u00A0\u00A0v${(props.upstream as AugmentedModuleMeta).version}`; return `v${props.canonical.version}`; }; @@ -92,7 +92,7 @@ export default function Card(props: { } onClick={() => props.runAction('download', () => - props.ctx.downloadModule(props.sourceMeta ?? props.canonical), + props.ctx.downloadModule(props.upstream ?? props.canonical), ) } /> diff --git a/packages/plugin/src/fs/vault/index.ts b/packages/plugin/src/fs/vault/index.ts index 1d0df69a..a05be50c 100644 --- a/packages/plugin/src/fs/vault/index.ts +++ b/packages/plugin/src/fs/vault/index.ts @@ -168,7 +168,9 @@ export default class VaultFs implements RootFs { : { isDir: true, key, meta }; } - async removeIfExist(key: string) { - if (await this.exists(key)) await this.delete(key); + removeIfExist(key: string) { + return this.exists(key).then((exists) => { + if (exists) return this.delete(key); + }); } } diff --git a/packages/plugin/src/modules/Extensibility.ts b/packages/plugin/src/modules/Extensibility.ts index 89e3a21a..6451853e 100644 --- a/packages/plugin/src/modules/Extensibility.ts +++ b/packages/plugin/src/modules/Extensibility.ts @@ -273,6 +273,7 @@ export default class Extensibility { ? await fetchSingleSource(url) : (this.sourceCache.get(url) ?? (await fetchSingleSource(url))); const seenId = new Set(); + const result: Array = []; content.forEach((meta: unknown) => { if (!isValidMeta(meta)) return; const { id, minPluginVersion, icon, main } = meta; @@ -282,7 +283,7 @@ export default class Extensibility { } if (seenId.has(id)) return; seenId.add(id); - modules.push({ + result.push({ ...meta, enabled: this.discoveredModules.get(id)?.enabled ?? false, icon: icon ?? 'puzzle', @@ -291,8 +292,9 @@ export default class Extensibility { source: url, }); }); + return result; }), - ); + ).then((sources) => sources.forEach((source) => modules.push(...source))); if (manual) new Notice( translate('discoveredModules', { diff --git a/packages/plugin/src/sdk/tsdown-plugin.ts b/packages/plugin/src/sdk/tsdown-plugin.ts index 262af32b..7446c841 100644 --- a/packages/plugin/src/sdk/tsdown-plugin.ts +++ b/packages/plugin/src/sdk/tsdown-plugin.ts @@ -14,30 +14,26 @@ type SyncEngineConfig = { }; type ModuleMeta = Partial< - Record<'name' | 'icon' | 'description' | 'source' | 'version' | 'readme', string> + Record<'id' | 'name' | 'icon' | 'description' | 'source' | 'version' | 'readme', string> >; -type ModuleMetaWithId = ModuleMeta & { id: string }; -const MAGIC_KEYS = ['name', 'icon', 'description', 'source', 'version', 'readme'] as const; +type MetaOption = ModuleMeta | Array | Record; + +const MAGIC_KEYS = ['id', 'name', 'icon', 'description', 'source', 'version', 'readme'] as const; function magicBytes(meta: ModuleMeta): string { const lines = MAGIC_KEYS.filter((key) => meta[key]).map((key) => `${key}: ${meta[key]}`); return `/*!\n${lines.join('\n')}\n*/\n`; } -function resolveMeta( - meta: ModuleMeta | Array | Record, - entryName: string, -): ModuleMeta | undefined { +function resolveMeta(meta: MetaOption, entryName: string): ModuleMeta | undefined { if (Array.isArray(meta)) return meta.find(({ id }) => id === entryName); if (typeof Object.values(meta)[0] === 'object') return (meta as Record)[entryName]; return meta; } -export default function syncEngineModule( - meta?: ModuleMeta | Array | Record, -) { +export default function syncEngineModule(meta?: MetaOption) { return { name: 'sync-engine-module', renderChunk(code: string, chunk: { name: string; isEntry: boolean }) {