Error when attempting to use GraphQLRequest

[0gust1]

Linked to #9

In version 5.1.1, when attempting to use GraphQLRequestin our server-side code:

import {GraphQLRequest} from "@rcsb/rcsb-api-tools/lib/RcsbGraphQL/GraphQLRequest";

We get this error:

Cannot find module '/<PROJECT_FOLDER>/node_modules/@rcsb/rcsb-api-tools/lib/RcsbLocalStorage/LocalStorageTools' imported from /<PROJECT_FOLDER>/node_modules/@rcsb/rcsb-api-tools/lib/RcsbGraphQL/GraphQLRequest.js

It should be noted that it worked before (v4.3.1) (and LocalStorageTools was already present in this version).

It seems that some changes in package configuration confuses bundlers, and then are unable to resolve the import {LocalStorageTools as LST} from "../RcsbLocalStorage/LocalStorageTools" directive in src/RcsbGraphQL/GraphQLRequest.ts.

If we attempt to use the commonJS version:

import pkg from '@rcsb/rcsb-api-tools';
const {GraphQLRequest} = pkg;

const RCSBGraphQLClient = new GraphQLRequest('sequence-coordinates', { fetch: fetch });
// ...code

we get an Error: GraphQLRequest is not a constructor

[0gust1]

For now, in our applicative code, we have changed the requests to the 'sequence-coordinates' API, using barebone fetch instead of the GraphQLRequest class. We're still using the types to secure our code downward.

[bioinsilico]

Thank you @0gust1 for reporting this issue. I will need to investigate what is happening. I haven't observed any issues when importing the request class as

import {GraphQLRequest} from "@rcsb/rcsb-api-tools/lib/RcsbGraphQL/GraphQLRequest";

[bioinsilico]

@0gust1, can you provide a minimal setup to reproduce this issue? I cannot reproduce it using ts-loader@9.5.2 and webpack@5.98.0

[0gust1]

@bioinsilico Sure, here a minimal setup similar to what we use: https://github.com/0gust1/Sveltekit-RCSB_API_tools-repro

It's a barebone project, scaffolded from the official Sveltekit tool. The only files I added/modified are the three files in src/routes/

The project uses vite (https://vite.dev/guide/features.html), which itself uses esm (https://github.com/evanw/esbuild)

The stacktrace:

Error [ERR_MODULE_NOT_FOUND]: Cannot find module '/<PROJECT_FOLDER>/node_modules/@rcsb/rcsb-api-tools/lib/RcsbLocalStorage/LocalStorageTools' imported from /<PROJECT_FOLDER>/node_modules/@rcsb/rcsb-api-tools/lib/RcsbGraphQL/GraphQLRequest.js
    at finalizeResolution (node:internal/modules/esm/resolve:275:11)
    at moduleResolve (node:internal/modules/esm/resolve:932:10)
    at defaultResolve (node:internal/modules/esm/resolve:1056:11)
    at ModuleLoader.defaultResolve (node:internal/modules/esm/loader:654:12)
    at #cachedDefaultResolve (node:internal/modules/esm/loader:603:25)
    at ModuleLoader.resolve (node:internal/modules/esm/loader:586:38)
    at ModuleLoader.getModuleJobForImport (node:internal/modules/esm/loader:242:38)
    at ModuleJob._link (node:internal/modules/esm/module_job:135:49) {
  code: 'ERR_MODULE_NOT_FOUND',
  url: 'file:///<PROJECT_FOLDER>/node_modules/@rcsb/rcsb-api-tools/lib/RcsbLocalStorage/LocalStorageTools'
}

[0gust1]

This kind of problem (esm vs commonjs and correct exposition to consuming apps/packages) is often a bit pesky and hair-pulling.

I noticed that the package.json of the package doesn't have module, types and exports fields. Those are often used to publish modules which can be used in various contexts (esm, cjs, ts) and in various environments (old runtimes and modern ones).

I also suppose we may need those fields and a more refined dual tsconfig, one for esm, and one for cjs (which would extend the first one). If I can carve some time (🤞), I will try some things.

Edit:

@bioinsilico , It seems I maybe got a working solution ? => #12

Disclaimer:

• I've burnt myself a lot of time the last 10 years over bundling/packaging/complex builds problems, so I partly (with care) LLM'ed the problem. I'm not very proud nor partisan of that (I'm quite critical and wary of those slop-prone generators).
• I'm a bit unaware of all the contexts where this package is used, at rcsb and outside of it. I guess some testing will be needed, and this will need a package version bump.