# What Fully deprecate old relations because we have one bug tied to it and it make the codebase complex # How I've made this PR: 1. remove metadata datasource (we only keep 'core') => this was causing extra complexity in the refactor + flaky reset 2. merge dev and demo datasets => as I needed to update the tests which is very painful, I don't want to do it twice 3. remove all code tied to RELATION_METADATA / relation-metadata.resolver, or anything tied to the old relation system 4. Remove ONE_TO_ONE and MANY_TO_MANY that are not supported 5. fix impacts on the different areas : see functional testing below # Functional testing ## Functional testing from the front-end: 1. Database Reset ✅ 2. Sign In ✅ 3. Workspace sign-up ✅ 5. Browsing table / kanban / show ✅ 6. Assigning a record in a one to many / in a many to one ✅ 7. Deleting a record involved in a relation ✅ => broken but not tied to this PR 8. "Add new" from relation picker ✅ => broken but not tied to this PR 9. Creating a Task / Note, Updating a Task / Note relations, Deleting a Task / Note (from table, show page, right drawer) ✅ => broken but not tied to this PR 10. creating a relation from settings (custom / standard x oneToMany / manyToOne) ✅ 11. updating a relation from settings should not be possible ✅ 12. deleting a relation from settings (custom / standard x oneToMany / manyToOne) ✅ 13. Make sure timeline activity still work (relation were involved there), espacially with Task / Note => to be double checked ✅ => Cannot convert undefined or null to object 14. Workspace deletion / User deletion ✅ 15. CSV Import should keep working ✅ 16. Permissions: I have tested without permissions V2 as it's still hard to test v2 work and it's not in prod yet ✅ 17. Workflows global test ✅ ## From the API: 1. Review open-api documentation (REST) ✅ 2. Make sure REST Api are still able to fetch relations ==> won't do, we have a coupling Get/Update/Create there, this requires refactoring 3. Make sure REST Api is still able to update / remove relation => won't do same ## Automated tests 1. lint + typescript ✅ 2. front unit tests: ✅ 3. server unit tests 2 ✅ 4. front stories: ✅ 5. server integration: ✅ 6. chromatic check : expected 0 7. e2e check : expected no more that current failures ## Remove // Todos 1. All are captured by functional tests above, nothing additional to do ## (Un)related regressions 1. Table loading state is not working anymore, we see the empty state before table content 2. Filtering by Creator Tim Ap return empty results 3. Not possible to add Tasks / Notes / Files from show page # Result ## New seeds that can be easily extended <img width="1920" alt="image" src="https://github.com/user-attachments/assets/d290d130-2a5f-44e6-b419-7e42a89eec4b" /> ## -5k lines of code ## No more 'metadata' dataSource (we only have 'core) ## No more relationMetadata (I haven't drop the table yet it's not referenced in the code anymore) ## We are ready to fix the 6 months lag between current API results and our mocked tests ## No more bug on relation creation / deletion --------- Co-authored-by: Weiko <corentin@twenty.com> Co-authored-by: Félix Malfait <felix@twenty.com>
238 lines
8.2 KiB
YAML
238 lines
8.2 KiB
YAML
name: CI Server
|
|
on:
|
|
push:
|
|
branches:
|
|
- main
|
|
|
|
pull_request:
|
|
|
|
concurrency:
|
|
group: ${{ github.workflow }}-${{ github.ref }}
|
|
cancel-in-progress: true
|
|
|
|
env:
|
|
SERVER_SETUP_CACHE_KEY: server-setup
|
|
|
|
jobs:
|
|
changed-files-check:
|
|
uses: ./.github/workflows/changed-files.yaml
|
|
with:
|
|
files: |
|
|
package.json
|
|
packages/twenty-server/**
|
|
packages/twenty-emails/**
|
|
packages/twenty-shared/**
|
|
server-setup:
|
|
needs: changed-files-check
|
|
if: needs.changed-files-check.outputs.any_changed == 'true'
|
|
timeout-minutes: 30
|
|
runs-on: depot-ubuntu-24.04-8
|
|
env:
|
|
NX_REJECT_UNKNOWN_LOCAL_CACHE: 0
|
|
services:
|
|
postgres:
|
|
image: twentycrm/twenty-postgres-spilo
|
|
env:
|
|
PGUSER_SUPERUSER: postgres
|
|
PGPASSWORD_SUPERUSER: postgres
|
|
ALLOW_NOSSL: 'true'
|
|
SPILO_PROVIDER: 'local'
|
|
ports:
|
|
- 5432:5432
|
|
options: >-
|
|
--health-cmd pg_isready
|
|
--health-interval 10s
|
|
--health-timeout 5s
|
|
--health-retries 5
|
|
redis:
|
|
image: redis
|
|
ports:
|
|
- 6379:6379
|
|
steps:
|
|
- name: Fetch custom Github Actions and base branch history
|
|
uses: actions/checkout@v4
|
|
with:
|
|
fetch-depth: 0
|
|
- name: Install dependencies
|
|
uses: ./.github/workflows/actions/yarn-install
|
|
- name: Restore server setup
|
|
id: restore-server-setup-cache
|
|
uses: ./.github/workflows/actions/restore-cache
|
|
with:
|
|
key: ${{ env.SERVER_SETUP_CACHE_KEY }}
|
|
- name: Build twenty-shared
|
|
run: npx nx build twenty-shared
|
|
- name: Server / Run lint & typecheck
|
|
uses: ./.github/workflows/actions/nx-affected
|
|
with:
|
|
tag: scope:backend
|
|
tasks: lint,typecheck
|
|
- name: Server / Build
|
|
run: npx nx build twenty-server
|
|
- name: Server / Write .env
|
|
run: npx nx reset:env twenty-server
|
|
- name: Server / Create DB
|
|
run: |
|
|
PGPASSWORD=postgres psql -h localhost -p 5432 -U postgres -d postgres -c 'CREATE DATABASE "default";'
|
|
PGPASSWORD=postgres psql -h localhost -p 5432 -U postgres -d postgres -c 'CREATE DATABASE "test";'
|
|
npx nx run twenty-server:database:init:prod
|
|
npx nx run twenty-server:database:migrate:prod
|
|
- name: Worker / Run
|
|
run: |
|
|
timeout 30s npx nx run twenty-server:worker || exit_code=$?
|
|
if [ $exit_code -eq 124 ]; then
|
|
# If timeout was reached (exit code 124), consider it a success
|
|
exit 0
|
|
elif [ $exit_code -ne 0 ]; then
|
|
# If worker failed for other reasons, fail the build
|
|
exit $exit_code
|
|
fi
|
|
- name: Server / Check for Pending Migrations
|
|
run: |
|
|
CORE_MIGRATION_OUTPUT=$(npx nx run twenty-server:typeorm migration:generate core-migration-check -d src/database/typeorm/core/core.datasource.ts || true)
|
|
|
|
CORE_MIGRATION_FILE=$(ls packages/twenty-server/*core-migration-check.ts 2>/dev/null || echo "")
|
|
|
|
if [ -n "$CORE_MIGRATION_FILE" ]; then
|
|
echo "::error::Unexpected migration files were generated. Please create a proper migration manually."
|
|
echo "$CORE_MIGRATION_OUTPUT"
|
|
|
|
rm -f packages/twenty-server/*core-migration-check.ts
|
|
|
|
exit 1
|
|
fi
|
|
- name: GraphQL / Check for Pending Generation
|
|
if: steps.changed-files.outputs.any_changed == 'true'
|
|
run: |
|
|
# Run GraphQL generation commands
|
|
npx nx run twenty-front:graphql:generate
|
|
npx nx run twenty-front:graphql:generate --configuration=metadata
|
|
|
|
# Check if any files were modified
|
|
if ! git diff --quiet; then
|
|
echo "::error::GraphQL schema changes detected. Please run 'npx nx run twenty-front:graphql:generate' and 'npx nx run twenty-front:graphql:generate --configuration=metadata' and commit the changes."
|
|
exit 1
|
|
fi
|
|
- name: Save server setup
|
|
uses: ./.github/workflows/actions/save-cache
|
|
with:
|
|
key: ${{ steps.restore-server-setup-cache.outputs.cache-primary-key }}
|
|
|
|
server-test:
|
|
timeout-minutes: 30
|
|
runs-on: depot-ubuntu-24.04-8
|
|
needs: server-setup
|
|
env:
|
|
NX_REJECT_UNKNOWN_LOCAL_CACHE: 0
|
|
steps:
|
|
- name: Fetch custom Github Actions and base branch history
|
|
uses: actions/checkout@v4
|
|
with:
|
|
fetch-depth: 0
|
|
- name: Install dependencies
|
|
uses: ./.github/workflows/actions/yarn-install
|
|
- name: Restore server setup
|
|
uses: ./.github/workflows/actions/restore-cache
|
|
with:
|
|
key: ${{ env.SERVER_SETUP_CACHE_KEY }}
|
|
- name: Server / Run Tests
|
|
uses: ./.github/workflows/actions/nx-affected
|
|
with:
|
|
tag: scope:backend
|
|
tasks: test
|
|
|
|
server-integration-test:
|
|
timeout-minutes: 30
|
|
runs-on: depot-ubuntu-24.04-8
|
|
needs: server-setup
|
|
services:
|
|
postgres:
|
|
image: twentycrm/twenty-postgres-spilo
|
|
env:
|
|
PGUSER_SUPERUSER: postgres
|
|
PGPASSWORD_SUPERUSER: postgres
|
|
ALLOW_NOSSL: 'true'
|
|
SPILO_PROVIDER: 'local'
|
|
ports:
|
|
- 5432:5432
|
|
options: >-
|
|
--health-cmd pg_isready
|
|
--health-interval 10s
|
|
--health-timeout 5s
|
|
--health-retries 5
|
|
redis:
|
|
image: redis
|
|
ports:
|
|
- 6379:6379
|
|
clickhouse:
|
|
image: clickhouse/clickhouse-server:latest
|
|
env:
|
|
CLICKHOUSE_PASSWORD: clickhousePassword
|
|
CLICKHOUSE_URL: "http://default:clickhousePassword@localhost:8123/twenty"
|
|
ports:
|
|
- 8123:8123
|
|
- 9000:9000
|
|
options: >-
|
|
--health-cmd "clickhouse-client --host=localhost --port=9000 --user=default --password=clickhousePassword --query='SELECT 1'"
|
|
--health-interval 10s
|
|
--health-timeout 5s
|
|
--health-retries 5
|
|
env:
|
|
NX_REJECT_UNKNOWN_LOCAL_CACHE: 0
|
|
NODE_ENV: test
|
|
ANALYTICS_ENABLED: true
|
|
CLICKHOUSE_URL: "http://default:clickhousePassword@localhost:8123/twenty"
|
|
CLICKHOUSE_PASSWORD: clickhousePassword
|
|
steps:
|
|
- name: Fetch custom Github Actions and base branch history
|
|
uses: actions/checkout@v4
|
|
with:
|
|
fetch-depth: 0
|
|
- name: Install dependencies
|
|
uses: ./.github/workflows/actions/yarn-install
|
|
- name: Update .env.test for integrations tests
|
|
run: |
|
|
echo "IS_BILLING_ENABLED=true" >> .env.test
|
|
echo "BILLING_STRIPE_API_KEY=test-api-key" >> .env.test
|
|
echo "BILLING_STRIPE_BASE_PLAN_PRODUCT_ID=test-base-plan-product-id" >> .env.test
|
|
echo "BILLING_STRIPE_WEBHOOK_SECRET=test-webhook-secret" >> .env.test
|
|
echo "BILLING_PLAN_REQUIRED_LINK=http://localhost:3001/stripe-redirection" >> .env.test
|
|
- name: Restore server setup
|
|
uses: ./.github/workflows/actions/restore-cache
|
|
with:
|
|
key: ${{ env.SERVER_SETUP_CACHE_KEY }}
|
|
- name: Server / Build
|
|
run: npx nx build twenty-server
|
|
- name: Build dependencies
|
|
run: |
|
|
npx nx build twenty-shared
|
|
npx nx build twenty-emails
|
|
- name: Server / Create Test DB
|
|
run: |
|
|
PGPASSWORD=postgres psql -h localhost -p 5432 -U postgres -d postgres -c 'CREATE DATABASE "test";'
|
|
- name: Run ClickHouse migrations
|
|
run: npx nx clickhouse:migrate twenty-server
|
|
- name: Run ClickHouse seeds
|
|
run: npx nx clickhouse:seed twenty-server
|
|
- name: Server / Run Integration Tests
|
|
uses: ./.github/workflows/actions/nx-affected
|
|
with:
|
|
tag: scope:backend
|
|
tasks: 'test:integration'
|
|
configuration: 'with-db-reset'
|
|
- name: Server / Upload reset-logs file
|
|
if: always()
|
|
uses: actions/upload-artifact@v4
|
|
with:
|
|
name: reset-logs
|
|
path: reset-logs.log
|
|
ci-server-status-check:
|
|
if: always() && !cancelled()
|
|
timeout-minutes: 5
|
|
runs-on: depot-ubuntu-24.04-8
|
|
needs: [changed-files-check, server-setup, server-test, server-integration-test]
|
|
steps:
|
|
- name: Fail job if any needs failed
|
|
if: contains(needs.*.result, 'failure')
|
|
run: exit 1
|