Skip to content

refactor: npm search service to io #328

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

Merged
merged 1 commit into from
May 17, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 2 additions & 5 deletions src/cli/cmd-search.ts
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,7 @@ import { CmdOptions } from "./options";
import { formatAsTable } from "./output-formatting";
import { AsyncResult, Ok, Result } from "ts-results-es";
import { HttpErrorBase } from "npm-registry-fetch/lib/errors";
import {
SearchedPackument,
SearchRegistryService,
} from "../services/search-registry";
import { SearchedPackument, SearchRegistry } from "../io/npm-search";
import { Registry } from "../domain/registry";
import { FetchAllPackuments } from "../io/all-packuments-io";
import { Logger } from "npmlog";
Expand All @@ -31,7 +28,7 @@ export type SearchCmd = (
*/
export function makeSearchCmd(
parseEnv: ParseEnvService,
searchRegistry: SearchRegistryService,
searchRegistry: SearchRegistry,
fetchAllPackuments: FetchAllPackuments,
log: Logger
): SearchCmd {
Expand Down
4 changes: 2 additions & 2 deletions src/cli/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ import { CmdOptions } from "./options";
import { makeAddCmd } from "./cmd-add";
import { makeAuthNpmrcService } from "../services/npmrc-auth";
import { makeNpmLoginService } from "../services/npm-login";
import { makeSearchRegistryService } from "../services/search-registry";
import { makeRegistrySearcher } from "../io/npm-search";
import pkg from "../../package.json";
import { makeSearchCmd } from "./cmd-search";
import { makeViewCmd } from "./cmd-view";
Expand Down Expand Up @@ -62,6 +62,7 @@ const saveNpmrc = makeNpmrcSaver(writeFile);
const loadProjectVersion = makeProjectVersionLoader(readFile);
const fetchPackument = makePackumentFetcher(regClient);
const fetchAllPackuments = makeAllPackumentsFetcher();
const searchRegistry = makeRegistrySearcher();

const parseEnv = makeParseEnvService(
log,
Expand All @@ -72,7 +73,6 @@ const parseEnv = makeParseEnvService(
);
const authNpmrc = makeAuthNpmrcService(findNpmrcPath, loadNpmrc, saveNpmrc);
const npmLogin = makeNpmLoginService(regClient);
const searchRegistry = makeSearchRegistryService();
const resolveRemotePackument =
makeResolveRemotePackumentService(fetchPackument);
const resolveLatestVersion = makeResolveLatestVersionService(fetchPackument);
Expand Down
2 changes: 1 addition & 1 deletion src/io/all-packuments-io.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ import { assertIsHttpError } from "../utils/error-type-guards";
import {
getNpmFetchOptions,
SearchedPackument,
} from "../services/search-registry";
} from "./npm-search";
import { DomainName } from "../domain/domain-name";
import { HttpErrorBase } from "npm-registry-fetch/lib/errors";

Expand Down
8 changes: 4 additions & 4 deletions src/services/search-registry.ts → src/io/npm-search.ts
Original file line number Diff line number Diff line change
Expand Up @@ -18,11 +18,11 @@ export type SearchedPackument = Readonly<
>;

/**
* Service function for searching packuments on a registry.
* Function for searching packuments on a registry.
* @param registry The registry to search.
* @param keyword The keyword to search.
*/
export type SearchRegistryService = (
export type SearchRegistry = (
registry: Registry,
keyword: string
) => AsyncResult<ReadonlyArray<SearchedPackument>, HttpErrorBase>;
Expand All @@ -42,9 +42,9 @@ export const getNpmFetchOptions = function (
};

/**
* Makes a {@link SearchRegistryService} function.
* Makes a {@link SearchRegistry} function.
*/
export function makeSearchRegistryService(): SearchRegistryService {
export function makeRegistrySearcher(): SearchRegistry {
return (registry, keyword) => {
return new AsyncResult(
npmSearch(keyword, getNpmFetchOptions(registry))
Expand Down
6 changes: 3 additions & 3 deletions test/cli/cmd-search.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@ import { makeSemanticVersion } from "../../src/domain/semantic-version";
import { makeMockLogger } from "./log.mock";
import {
SearchedPackument,
SearchRegistryService,
} from "../../src/services/search-registry";
SearchRegistry,
} from "../../src/io/npm-search";
import { exampleRegistryUrl } from "../domain/data-registry";
import { Err, Ok } from "ts-results-es";
import { HttpErrorBase } from "npm-registry-fetch/lib/errors";
Expand All @@ -30,7 +30,7 @@ function makeDependencies() {
Ok({ registry: { url: exampleRegistryUrl, auth: null } } as Env)
);

const searchRegistry = mockService<SearchRegistryService>();
const searchRegistry = mockService<SearchRegistry>();
searchRegistry.mockReturnValue(Ok([exampleSearchResult]).toAsyncResult());

const getAllPackuments = mockService<FetchAllPackuments>();
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
import npmSearch from "libnpmsearch";
import search from "libnpmsearch";
import { HttpErrorBase } from "npm-registry-fetch/lib/errors";
import { makeSearchRegistryService } from "../../src/services/search-registry";
import { makeRegistrySearcher } from "../../src/io/npm-search";
import { Registry } from "../../src/domain/registry";
import { exampleRegistryUrl } from "../domain/data-registry";

Expand All @@ -13,11 +13,11 @@ const exampleRegistry: Registry = {
};

function makeDependencies() {
const searchRegistry = makeSearchRegistryService();
const searchRegistry = makeRegistrySearcher();
return { searchRegistry } as const;
}

describe("search service", () => {
describe("npm search", () => {
it("should fail for error response", async () => {
const expected = {
message: "Idk, it failed",
Expand Down
Loading