mirror of https://github.com/andwati/zitadel.git synced 2026-11-07 22:55:12 +00:00

Files

T

RamonandGitHub 7b6395c348 fix: improve NX caching (#11434 )

# Which Problems Are Solved
This PR improves our NX caching, especially for the console and api.
It makes sure that if the console is changed the api is also rebuilt and
if the api is changed the functional-ui tests are rerun. It is important
to note this only fixes a subset of our problems.

# How the Problems Are Solved
NX ignores .gitignored files even if they are explicitly added to the
inputs of an NX target. To counteract this one can add these files to a
.nxignore file with a negated pattern.
https://nx.dev/docs/reference/inputs#token-behavior-with-nested-projects
. This solution is not documented per se but can be find in this Github
issue: https://github.com/nrwl/nx/issues/6821 . Further more nx
calculates the hashes of inputs at the start and does not recalculate
them even if a dependency of a target changes. To solve this problem one
needs to use
https://nx.dev/docs/reference/inputs#outputs-of-dependent-tasks . This
comment of an NX developer helped me further to understand the actual
behaviour of NX:
https://github.com/nrwl/nx/issues/33379#issuecomment-3657929455 .

# Additional Changes
Because the functional-ui tests now correctly run again they had to be
fixed. This pr unifies the field names in the user create v1 and v2 ui.

# Additional Context
To document this somewhere, this proposed fix does not work:
https://github.com/nrwl/nx/issues/6821#issuecomment-1309475504 . In my
local testing NX runtime inputs also get executed at the beginning of
the NX loop and ignore subsequent changes by targets. While testing this
fix and browsing through NX code I found this, which could be helpful in
the future and isn't documented: https://github.com/nrwl/nx/pull/31428

2026-01-29 14:42:52 +01:00

src

fix: improve NX caching (#11434 )

2026-01-29 14:42:52 +01:00

.editorconfig

feat(console): integrate frontend (#95 )

2020-05-13 14:41:43 +02:00

.env.dev

chore: rehaul DevX (#10571 )

2025-10-08 10:27:02 +02:00

.eslintrc.js

fix(console): update eslint, redirect user without roles, private labeling save and icon (#4459 )

2022-09-29 05:25:57 +00:00

.prettierignore

chore(e2e): formatting with prettier (#4385 )

2022-09-19 19:49:46 +02:00

.prettierrc

fix(console): use authService for auth user page (#5233 )

2023-02-27 12:03:44 +01:00

angular.json

feat(i18n): add Arabic language support (#11161 )

2026-01-22 17:07:47 +01:00

buf.gen.yaml

fix: use versioned openapi protoc plugin for docs and console (#11423 )

2026-01-26 13:20:46 +01:00

karma.conf.js

feat(console): integrate frontend (#95 )

2020-05-13 14:41:43 +02:00

ngsw-config.json

fix: update assets in ngsw-config.json (#1027 )

2020-11-27 16:32:14 +01:00

package.json

fix(console): remove rehauled navigation #10863 (#10912 )

2026-01-16 08:30:09 +01:00

prebuild.development.js

chore(dev): fix fetching http env json (#5921 )

2023-05-24 13:07:55 +00:00

project.json

fix: improve NX caching (#11434 )

2026-01-29 14:42:52 +01:00

README.md

chore: management console naming inconsistency (#11390 )

2026-01-26 14:52:15 +00:00

tsconfig.app.json

chore(console): Angular 20 #10690 (#10768 )

2025-10-08 07:10:50 +00:00

tsconfig.json

chore(console): Angular 20 #10690 (#10768 )

2025-10-08 07:10:50 +00:00

tsconfig.spec.json

chore(console): dependency update (#5653 )

2023-04-18 15:42:29 +02:00

README.md

Zitadel Management Console

The Management Console is Zitadels management UI.

It is built using Angular and part of the Zitadel monorepo.

To get started follow the contributing quick start.

Building

To build for production:

pnpm nx run @zitadel/console:build

This will:

Generate proto files (via prebuild script)
Build the Angular app with production optimizations

Linting

To run linting and formatting checks:

pnpm nx @zitadel/console:lint

To auto-fix formatting issues:

pnpm nx @zitadel/console:lint-fix

Project Structure

src/app/proto/generated/ - Generated proto files (Angular-specific format)
buf.gen.yaml - Local proto generation configuration
project.json - Nx orchestration and caching for builds and tests
prebuild.development.js - Development environment configuration script

Dependency Chain

The Management Console app has the following build dependencies managed by Nx:

@zitadel/proto:generate - Generates the protobuf stubs
@zitadel/client:build - Builds the TypeScript gRPC client library
@zitadel/console:generate - Generates Management Console-specific protobuf stubs
@zitadel/console:build - Creates a production build from Management Console

This ensures that the Management Console always has access to the latest client library and protobuf definitions.

Proto Generation Details

@zitadel/proto generation: Modern ES modules with @bufbuild/protobuf for v2 APIs
Local buf.gen.yaml generation: Traditional protobuf JavaScript classes for v1 APIs

The Management Console app calls Zitadel v1 and v2 APIs. As long as the Management Console still calls v1 APIs, it needs to import client stubs from separate sources:

Source outputs from direct buf generation for v1 APIs
@zitadel/client for v2 APIs

Legacy v1 API (Traditional Protobuf)

Uses local buf.gen.yaml configuration
Generates traditional Google protobuf JavaScript classes extending jspb.Message
Uses plugins: protocolbuffers/js, grpc/web, grpc-ecosystem/openapiv2
Output: src/app/proto/generated/
Used for: Most existing Management Console functionality

Modern v2 API (ES Modules)

Uses @zitadel/proto package generation
Generates modern ES modules with @bufbuild/protobuf
Uses plugin: @bufbuild/es with ES modules and JSON types
Output: login/packages/zitadel-proto/
Used for: New user v2 API and services

Dependency Management

The Management Console's project.json ensures proper execution order:

@zitadel/proto:generate runs first (modern ES modules)
Management Console's local generation runs second (traditional protobuf)
Build/lint/start tasks depend on both generations being complete

This approach allows the Management Console app to use both v1 and v2 APIs while maintaining proper build dependencies.

Legacy Information

This project was originally generated with Angular CLI version 8.3.20 and has been updated over time.