mdn / mdn/dex

Publish cloud function as `@mdn/dex-cloud-server`

Open
#527 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

needs triage
Dominant language
JavaScript
Stars
6
Forks
4
Avg merge
21h 12m
Merged PRs (30d)
32

Description

What information was incorrect, unhelpful, or incomplete?

Fred needs to run the Dex cloud function as its local ingress server, but the cloud-function package is private and only runnable from a Dex checkout.

Requiring a sibling Dex checkout would make Fred's development setup difficult to install and version consistently.

What did you expect to see?

Publish cloud-function as the public npm package @mdn/dex-cloud-server.

The package should:

  • Provide a dex-cloud-server executable that starts the existing mdnHandler.
  • Continue supporting deployment through Google Cloud Functions.
  • Expose the handler or createHandler through a package export where useful for testing.
  • Include the runtime files required to start the server.
  • Support CANONICALS_FILE and REDIRECTS_FILE.
  • Be published with npm provenance through an automated release workflow.

Fred can then depend on a pinned package version and run Dex as a separate local process.

Do you have any supporting links, references, or citations?

Blocked by:

Do you have anything more you want to share?

Integrating the package into Fred's development startup and providing combined Fred and Dex PR preview deployments are outside the scope of this issue. PR previews are worth investigating after Fred uses the published Dex server.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by checking the blocking issue #526, then inspect the existing cloud-function package and its mdnHandler/createHandler entry points. Trace the runtime files, executable setup, and deployment configuration before deciding where the automated npm release workflow belongs. Done means @mdn/dex-cloud-server can run the handler, remain deployable as a Google Cloud Function, support both file environment variables, and expose the useful handler export.

Written by the indexing model from the issue text.

Assessment

Tech stack
gcp, javascript, node.js
Domain
backend, cloud, release
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Active
Clarity
Mostly clear
Newbie friendliness
63/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.