Allow creation of executable binary combined frontend/backend #38

ejfine · 2025-05-28T17:02:14Z

Link to Issue or Message thread

#21

Why is this change necessary?

Need to be able to deploy non-docker applications that have access to local computer

How does this change address the issue?

Creates option for a pyinstaller executable that serves a static frontend as part of it

What side effects does this change have?

None

How is this change tested?

Downstream repo using pyinstaller and one with a standard docker graphql backend

Other

Switched to just using standard playwright for E2E testing---created separate "compiled" testing that using the vitest fancy nuxt stuff

Optimized docker build layers

Added a shutdown route and moved all the API under /api to not conflict with serving a static website

Removed some of the unnecessary needs from the required-check job

Close #21 along with creating a CLI for specifying things like port and log folder

Copilot

Pull Request Overview

This PR adds support for building a standalone executable (via PyInstaller) alongside the existing Docker workflow, restructures the API under /api, and updates test and CI configurations to handle both Docker and compiled binary deployments.

Introduce deploy_as_executable flag in copier.yml and adjust CI to build or pull artifacts accordingly
Update frontend/backend routing to use /api/graphql, adjust test harness, and add deterministic Faker seeding
Enhance GitHub Actions to include compiled‐binary build/test steps and optimize Docker layers

Reviewed Changes

Copilot reviewed 41 out of 41 changed files in this pull request and generated 3 comments.

Show a summary per file

File	Description
template/frontend/.dockerignore	Exclude test files and `.dockerignore` from build context
template/frontend/codegen.ts	Point GraphQL schema to `/api/graphql`
template/frontend/vitest.config.ts	Register setup files for Faker and application launcher
template/frontend/tests/setup/faker.ts	Seed Faker deterministically before each test
template/frontend/tests/setup/constants.ts.jinja	Export deployed ports and application name
template/frontend/tests/setup/app.ts	New E2E harness launching either Docker or compiled executable backend
template/frontend/tests/e2e/index.spec.ts	Switch to shared `getPage`/`url` helpers and remove redundant setup
template/frontend/tests/e2e/constants.ts.jinja	Remove outdated port constant
template/frontend/tests/compiled/index.spec.ts	Add a compiled‐frontend smoke test
template/frontend/package.json.jinja	Refine test scripts, add `--run` flag and include `playwright`
template/frontend/nuxt.config.ts.jinja	Add runtime public config for `graphql_api_url`
template/deployment/docker-compose.yaml.jinja	Update `GRAPHQL_API_URL` to use `/api/graphql`
template/README.md.jinja	Update uvicorn entrypoint path
template/.pre-commit-config.yaml.jinja	Exclude favicons from large file checks
template/.github/workflows/ci.yaml.jinja	Extend matrix and add compiled build/test jobs
template/.github/actions/install_deps_uv/manual-setup-deps.ps1	Adjust backend path resolution in CI action
template/.devcontainer/devcontainer.json.jinja	Enable shared Python modules when using executable deploy
template/.coveragerc	Remove `entrypoint.py` from omit list
copier.yml	Add `deploy_as_executable` and conditional parameters
.github/workflows/ci.yaml	Include an extra copier data file in CI tests

Copilot · 2025-05-28T17:05:33Z

template/frontend/tests/setup/app.ts

+        throw new Error(`Failed to stop the application: ${res.statusText}`);
+      }
+    }
+    if (isDockerE2E) {


In the Docker E2E branch you never close the Playwright browser. Consider moving await browser.close() outside the conditional or adding it inside the if (isDockerE2E) block to avoid resource leaks.

Copilot · 2025-05-28T17:05:33Z

template/frontend/package.json.jinja

@@ -52,6 +52,7 @@
    "happy-dom": "^17.4.4",{% endraw %}{% if frontend_uses_graphql %}{% raw %}
    "mock-apollo-client": "^1.3.1",
    "nuxt-codegen": "^1.3.1",{% endraw %}{% endif %}{% raw %}
+    "playwright": "^1.52.0",
    "playwright-core": "^1.51.1",


The playwright and playwright-core dependencies are on different versions (1.52.0 vs 1.51.1). Aligning these versions can prevent subtle compatibility issues.

Suggested change

"playwright-core": "^1.51.1",

"playwright-core": "^1.52.0",

Copilot · 2025-05-28T17:05:34Z

template/.github/actions/install_deps_uv/manual-setup-deps.ps1

@@ -25,7 +25,7 @@ $env:Path = "C:\Users\runneradmin\.local\bin;$env:Path"


 $SCRIPT_DIR = Split-Path -Parent $MyInvocation.MyCommand.Definition
-$PROJECT_ROOT_DIR = Resolve-Path (Join-Path $SCRIPT_DIR "..")
+$PROJECT_ROOT_DIR = Resolve-Path (Join-Path $SCRIPT_DIR -ChildPath ".." | Join-Path -ChildPath ".." | Join-Path -ChildPath ".." | Join-Path -ChildPath "backend") # TODO: figure out a better approach than this hack way of specifying backend directory


[nitpick] This deeply nested Join-Path chain is brittle. Consider computing the backend path relative to a known environment variable or using a configuration input to simplify resolution.

Copilot

Pull Request Overview

This PR enables deploying the application as a standalone executable by integrating pyinstaller and adjusting configuration files, scripts, and workflows to support combined frontend/backend builds. Key changes include:

Introducing a deploy_as_executable option in configuration files and conditional logic for CI and image creation.
Updating various dependency versions and switching from shell scripts to Python-based tooling installation.
Streamlining environment configurations and CI workflows to support both Python and Node setups.

Reviewed Changes

Copilot reviewed 65 out of 65 changed files in this pull request and generated 2 comments.

Show a summary per file

File	Description
template/.devcontainer/envs.json.jinja	Added environment configuration with conditional backend inclusion.
template/.devcontainer/devcontainer.json.jinja	Enabled shared settings for executable deployment based on new flag.
template/.coveragerc	Removed entrypoint.py from coverage omissions.
pyproject.toml	Pinned the pyright version to avoid known issues.
extensions/context.py	Updated various dependency versions.
copier.yml	Introduced deploy_as_executable flag and adjusted conditions for image deployment.
README.md	Updated setup command to invoke the Python-based installation script.
.github/workflows/pre-commit.yaml & ci.yaml	Modified workflow steps to install dependencies and pass Node version appropriately.
.devcontainer/* & .github/actions/*	Replaced/deleted deprecated scripts and added Python alternatives for CI tooling.
.copier-answers.yml	Updated commit identifier.

Copilot · 2025-05-29T15:31:32Z

copier.yml

@@ -141,7 +150,7 @@ backend_image_name:
    type: str
    help: What is the name of the backend image?
    default: "{{ repo_name }}/backend"
-    when: "{{ has_backend }}"
+    when: "{{ has_backend and not deploy_as_executable}}"


[nitpick] Consider adding a space before the closing curly brace for consistency (e.g., "{{ has_backend and not deploy_as_executable }}").

Suggested change

when: "{{ has_backend and not deploy_as_executable}}"

when: "{{ has_backend and not deploy_as_executable }}"

Copilot · 2025-05-29T15:31:33Z

.github/workflows/ci.yaml

        with:
          python-version: ${{ matrix.python-version }}
+          node-version: 22.14.0 # TODO: don't hardcode this


Avoid hardcoding the Node version; consider parameterizing this value to enhance maintainability.

Suggested change

node-version: 22.14.0 # TODO: don't hardcode this

node-version: ${{ env.NODE_VERSION }} # Using parameterized Node.js version

ejfine added 30 commits May 27, 2025 11:23

add question

6e4bc50

tests

e1a1244

spec

809a55f

spell

361e29c

jinja

252e857

Move entrypoint

c9d569c

fix jinja

652091b

add init

1bec4bd

enable shared

2aee808

update docker

68402e4

constants

e60572c

more constants

6771359

more constants

ac1d141

cli

e34bbf1

raw

6735b1c

More spec

b7868a0

logger

8540011

ignore

2aecf30

more static

9226485

whiespace

dd4a27d

put graphql under API heading

e6f08cd

spec

6c9a35f

uvocirn launch

7d18a13

format

b359135

whitespace

091c6dd

swagger

b3b8bc4

import

9af38b5

whitespace

f4d51a1

field

99f1d47

conditional

496a38e

Copilot AI reviewed May 28, 2025

View reviewed changes

ejfine added 22 commits May 28, 2025 17:09

PR comments

3a4874a

127

65fff28

add to generate

1646c14

all host

778ca2d

renmae

2926837

logiNG

cacc608

more logging

206c528

More file checks

808edef

error no file

684de4a

Tar

ded53b7

ci fix

efbcdf8

fix ci

fd45320

copier

a1712e8

ci

ae3476c

dot-env

3cb7c1e

copier taol

526879e

sntax

7beb936

More updates

ddf4df9

fi xsync

5555ca7

coiper

4fbea9b

new dotenv

df56d6e

copier devcon

c47f7d2

ejfine requested a review from Copilot May 29, 2025 15:30

Copilot AI reviewed May 29, 2025

View reviewed changes

ejfine added 3 commits May 29, 2025 15:54

del sh

f36e4e5

whitespace

a859ab4

tag

94e69ab

ejfine merged commit 7a7aeaf into main May 29, 2025
10 checks passed

ejfine deleted the binary branch May 29, 2025 16:28

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Allow creation of executable binary combined frontend/backend #38

Allow creation of executable binary combined frontend/backend #38

Uh oh!

ejfine commented May 28, 2025

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI May 28, 2025

Uh oh!

Copilot AI May 28, 2025

Uh oh!

Copilot AI May 28, 2025

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI May 29, 2025

Uh oh!

Copilot AI May 29, 2025

Uh oh!

Uh oh!

Uh oh!

	when: "{{ has_backend and not deploy_as_executable}}"
	when: "{{ has_backend and not deploy_as_executable }}"

	node-version: 22.14.0 # TODO: don't hardcode this
	node-version: ${{ env.NODE_VERSION }} # Using parameterized Node.js version

Allow creation of executable binary combined frontend/backend #38

Allow creation of executable binary combined frontend/backend #38

Uh oh!

Conversation

ejfine commented May 28, 2025

Link to Issue or Message thread

Why is this change necessary?

How does this change address the issue?

What side effects does this change have?

How is this change tested?

Other

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Copilot AI May 28, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI May 28, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI May 28, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Copilot AI May 29, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI May 29, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!