Skip to content

fix(compatibility): a renamed function's old route is not a known issue #6

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.

Sign up for GitHub

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
sanjevirau merged 1 commit into from
Nov 14, 2026
Merged

fix(compatibility): a renamed function's old route is not a known issue #6

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
8 changes: 5 additions & 3 deletions src/content/docs/docs/services/functions.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -168,9 +168,11 @@ nothing](/docs/functions/debugging#if-a-save-seems-to-change-nothing), the
log, the terminal screen and the console say why. In a terminal, `r`
reloads by hand.

In 0.2.4, a function you remove, rename or move to another region (a
`region` param changed in `.env`, for one) keeps its old route until the
emulators restart. A call to the old route answers `500`, and the log says:
A function you remove, rename or move to another region (a `region` param
changed in `.env`, for one) keeps its old route until the emulators restart,
as it does in the official emulator: a call to the old route answers `500`
with `{"code":"ECONNRESET"}` in both (firebase-tools 15.35.0), and Firenook's
log says:

```text
firenook functions[us-central1-params]: the source no longer exports this function (record kept from an earlier load)
Expand Down
13 changes: 5 additions & 8 deletions src/lib/compatibility.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -229,15 +229,12 @@ export const platforms = {
/**
* What is wrong in this release, found while the docs were checked against
* it, each with where the docs show the way around it. Fixes are tracked in
* the engine repository.
* the engine repository. The page leaves the section out while it is empty.
* (A function removed, renamed or moved to another region keeping its old
* route until a restart was listed here; firebase-tools 15.35.0 answers that
* route the same way, `500 {"code":"ECONNRESET"}`, so it is not Firenook's.)
*/
export const knownIssues: { area: string; text: string; href: string }[] = [
{
area: 'Cloud Functions',
text: 'A function you remove, rename or move to another region keeps its old route until a restart, and a call there fails.',
href: '/docs/services/functions',
},
];
export const knownIssues: { area: string; text: string; href: string }[] = [];

/**
* Where the official emulator and production disagree, what Firenook does,
Expand Down
50 changes: 27 additions & 23 deletions src/pages/compatibility.astro
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -314,30 +314,34 @@ const fixedCount = found.reduce((sum, release) => sum + (release.date ? release.
</div>
</section>

<section class="section" aria-labelledby="known-issues">
<div class="wrap">
<div class="head">
<h2 id="known-issues">Known issues in {site.version}</h2>
<p class="lede">
What is wrong in this release, found while these docs were checked against it. Each one links to the way around
it.
</p>
{
knownIssues.length > 0 && (
<section class="section" aria-labelledby="known-issues">
<div class="wrap">
<div class="head">
<h2 id="known-issues">Known issues in {site.version}</h2>
<p class="lede">
What is wrong in this release, found while these docs were checked against it. Each one links to the way around
it.
</p>
</div>
<ul class="issues block">
{
knownIssues.map((issue, index) => (
<li>
<span class="issue-area">{index > 0 && knownIssues[index - 1].area === issue.area ? '' : issue.area}</span>
<p>
{withCode(issue.text).map((part) => (part.code ? <code>{part.text}</code> : part.text))}{' '}
<a href={issue.href}>The way around it</a>
</p>
</li>
))
}
</ul>
</div>
<ul class="issues block">
{
knownIssues.map((issue, index) => (
<li>
<span class="issue-area">{index > 0 && knownIssues[index - 1].area === issue.area ? '' : issue.area}</span>
<p>
{withCode(issue.text).map((part) => (part.code ? <code>{part.text}</code> : part.text))}{' '}
<a href={issue.href}>The way around it</a>
</p>
</li>
))
}
</ul>
</div>
</section>
</section>
)
}

<Closing id="check" title="Check your own project">
<Fragment slot="lede">
Expand Down
9 changes: 8 additions & 1 deletion src/pages/firestore-emulator.astro
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ import BenchPairs from '../components/BenchPairs.astro';
import KeepData from '../components/KeepData.astro';
import Faq from '../components/Faq.astro';
import Closing from '../components/Closing.astro';
import { knownIssues } from '../lib/compatibility';
import firestoreShot from '../assets/console/firestore-dark.png';
import { site } from '../lib/site';
import { page } from '../lib/pages';
Expand Down Expand Up @@ -148,7 +149,13 @@ const schema = graph(
</ul>
<p class="note">
Every production feature, edition or client version is not claimed. <a href="/compatibility#firestore">What
Firestore covers in {site.version}</a>, and <a href="/compatibility#known-issues">the release’s known issues</a>.
Firestore covers in {site.version}</a>{
knownIssues.length > 0 ? (
<>
, and <a href="/compatibility#known-issues">the release’s known issues</a>
</>
) : null
}.
</p>
</div>
</section>
Expand Down
Loading