public-transport/hafas-client

support environments without support for createRequire() & JSON modules

Open

#300 opened on Oct 22, 2023

View on GitHub
 (5 comments) (0 reactions) (0 assignees)JavaScript (60 forks)github user discovery
enhancementhelp wanted

Repository metrics

Stars
 (353 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

Hi there, I just tried to deploy a Next.js app with React server components using hafas-client to Vercel. It always worked as intended on my machine, but never when deployed to a lambda function as I always got a "could not import base.json" error. I even went as far as forking the package and replacing the require statement with an import, but that resulted in a lambda timeout. The solution was to use node 16 instead of node 18 in the Vercel config. I also changed the region from Washington D.C. to Frankfurt, but that probably won't make any difference.

I hope this info helped anyone, but it took me like 3 hours to troubleshoot.

Edit: i reverted back to using the official published npm package instead of my fork, but this broke it again and i got the " Cannot find module './base.json'" Error again.

Contributor guide

Research direction
Investigate the use of createRequire and JSON modules in hafas client. Determine the root cause of the failure in Node 18 environments (e.g., Vercel) and implement a fix that uses import assertions or a different approach to load JSON files that works in all supported Node versions.
Tech stack
javascriptnodejs
Domain
backendapi
Issue type
Bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
JavaScriptNode.js
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60