Infrastructure/logto
0
Fork 0
mirror of https://github.com/logto-io/logto.git synced 2025-02-10 21:58:23 -05:00
Code Issues Activity

fix(cli): fix cli add official connectors command missing connectors bug (#7013)

Browse source 
* fix(cli): fix cli add offical connectors command missing connectors bug

fix cli add offical connectors command missing connectors bug

* chore(cli): update comments

update comments
This commit is contained in:
simeng-li 2025-02-08 17:30:53 +08:00 • committed by GitHub
parent c0ecebd81b
commit cb261024b6
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
2 changed files with 29 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
.changeset/rotten-bugs-pretend.md Normal file
View file

@ -0,0 +1,8 @@
---
"@logto/cli": patch
---
fix(cli): fix cli add offical connectors command missing connectors bug
Fix the bug when running the cli commend `logto connectors add --official`, only 8 connectors are fetched from npm registry.
This fix update logic to query additional pages of results when fetching connectors from the npm registry.

25
packages/cli/src/commands/connector/utils.ts
View file

@ -144,6 +144,25 @@ const officialConnectorPrefix = '@logto/connector-';
type PackageMeta = { name: string; scope: string; version: string };
const maintainer = 'gaosun';
/**
* This function fetches the list of Logto official connectors from the NPM registry.
*
* @remarks
* This fetching logic is based on the NPM registry API.
* @see {@link https://github.com/npm/registry/blob/master/docs/REGISTRY-API.md#get-v1search}
*
* @remarks
* Known limitations of the NPM registry API:
* 1. The `fetchList` API request performs a 'fuzzy' search using the `text` parameter with the package name prefix `@logto/connector-`, resulting in many irrelevant results (over 1000), making it difficult to filter all official connectors.
* 2. The `scope:logto` search qualifier does not function as intended, failing to properly filter `@logto` scope packages.
*
* To mitigate these limitations:
* - We replace `scope:logto` with the `maintainer:gaosun` qualifier to reduce irrelevant results, which helps in filtering official connectors.
* - In addition to the API search, we filter results by checking the package name prefix `@logto/connector-`.
* - We continue fetching pages from the registry search API until the last page, applying the above filtering logic to compile the final list of official connectors.
*/
export const fetchOfficialConnectorList = async (includingCloudConnectors = false) => {
// See https://github.com/npm/registry/blob/master/docs/REGISTRY-API.md#get-v1search
type FetchResult = {
@ -156,7 +175,7 @@ export const fetchOfficialConnectorList = async (includingCloudConnectors = fals
const fetchList = async (from = 0, size = 20) => {
const parameters = new URLSearchParams({
text: officialConnectorPrefix,
text: `${officialConnectorPrefix} maintainer:${maintainer}`,
from: String(from),
size: String(size),
});
@ -170,8 +189,6 @@ export const fetchOfficialConnectorList = async (includingCloudConnectors = fals
const excludeList = ['mock', 'kit', ...conditionalArray(!includingCloudConnectors && 'logto')];
// The API called by `fetchList` performs a 'fuzzy' search based on the `text` parameter, which will yield many irrelevant results. We need to filter out these irrelevant results (using `name.startsWith(officialConnectorPrefix)` for filtering).
// Disable lint rules for business need
// eslint-disable-next-line @silverhand/fp/no-let, @silverhand/fp/no-mutation
for (let page = 0; ; ++page) {
// eslint-disable-next-line no-await-in-loop
@ -188,7 +205,7 @@ export const fetchOfficialConnectorList = async (includingCloudConnectors = fals
// eslint-disable-next-line @silverhand/fp/no-mutating-methods
packages.push(...objects.map(({ package: data }) => data));
if (objects.length < 20) {
if (rawObjects.length < 20) {
break;
}
}