Skip to content

feat: migrate OrganizationOnboarding.logo to use avatars table #22747

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.

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

Draft
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

zomars
Copy link
Member

@zomars zomars commented Jul 25, 2025

feat: migrate OrganizationOnboarding.logo to use avatars table

Summary

This PR migrates the OrganizationOnboarding.logo column from storing base64 image data directly to using the existing avatar system that stores images in the avatars table and returns URLs. This is an incremental migration that:

  • Adds logoUrl field to OrganizationOnboarding schema
  • Marks the existing logo field as deprecated for backward compatibility
  • Updates organization creation handlers to process base64 logo data using uploadLogo
  • Modifies all relevant code paths to prefer logoUrl while falling back to logo
  • Updates the onboarding store to handle both fields during the transition

The migration follows the same pattern used by teams and organizations for logo handling, moving away from storing large base64 strings directly in the database.

Review & Testing Checklist for Human

  • Test end-to-end organization creation flow with logo upload - Create a new organization through the UI and verify the logo uploads correctly and displays properly
  • Verify base64 logo processing works correctly - Test with different image formats (PNG, JPEG) and sizes to ensure the base64 detection and upload logic works
  • Check backward compatibility - Verify existing organizations with logos still display correctly and that old onboarding records work
  • Review database migration - Ensure the migration adds the logoUrl column without issues and can be safely deployed to production
  • Test both self-hosted and payment intent organization creation flows - Both code paths were modified and need verification

Recommended Test Plan:

  1. Start organization creation flow in local environment
  2. Upload a logo image and complete organization setup
  3. Verify the logo displays correctly in the organization profile
  4. Check database to confirm logoUrl is populated and points to avatar system
  5. Test with existing organizations to ensure no regressions

Diagram

%%{ init : { "theme" : "default" }}%%
graph TD
    UI["Organization Creation UI"]
    Store["onboardingStore.ts"]:::minor-edit
    CreatePayment["createWithPaymentIntent.handler.ts"]:::major-edit
    CreateSelf["createSelfHosted.handler.ts"]:::major-edit
    PaymentService["OrganizationPaymentService.ts"]:::minor-edit
    CreateOrg["createOrganizationFromOnboarding.ts"]:::major-edit
    Repository["organizationOnboarding.ts"]:::minor-edit
    Schema["schema.prisma"]:::major-edit
    AvatarSystem["avatar.ts"]:::context
    Database[("Database<br/>OrganizationOnboarding<br/>+ Avatar tables")]:::context

    UI -->|"logo upload"| Store
    Store -->|"logo data"| CreatePayment
    Store -->|"logo data"| CreateSelf
    CreatePayment -->|"process payment"| PaymentService
    CreatePayment -->|"base64 detection<br/>& upload"| AvatarSystem
    CreateSelf -->|"base64 detection<br/>& upload"| AvatarSystem
    CreatePayment -->|"create org"| CreateOrg
    CreateSelf -->|"create org"| CreateOrg
    CreateOrg -->|"save data"| Repository
    Repository -->|"persist"| Database
    AvatarSystem -->|"store image"| Database
    PaymentService -->|"update onboarding"| Repository

    subgraph Legend
        L1["Major Edit"]:::major-edit
        L2["Minor Edit"]:::minor-edit
        L3["Context/No Edit"]:::context
    end

    classDef major-edit fill:#90EE90
    classDef minor-edit fill:#87CEEB
    classDef context fill:#FFFFFF
Loading

Notes

  • The migration preserves the existing logo field as deprecated to maintain backward compatibility
  • Base64 detection logic matches existing patterns in the codebase for team/organization logo handling
  • The uploadLogo function handles storing images in the avatars table and returning URLs
  • All organization creation flows (both payment and self-hosted) were updated to use the new system

Link to Devin run: https://app.devin.ai/sessions/b56ecd2b3f7b42529ba4546f99d0c221
Requested by: @zomars

- Add logoUrl field to OrganizationOnboarding schema
- Mark logo field as deprecated for backward compatibility
- Update handlers to process base64 logo data using uploadLogo
- Modify createOrganizationFromOnboarding to prefer logoUrl
- Update onboarding store to handle logoUrl
- Ensure all organization creation flows use avatar system

Co-Authored-By: zomars@cal.com <zomars@me.com>
Copy link
Contributor

🤖 Devin AI Engineer

I'll be helping with this pull request! Here's what you should know:

✅ I will automatically:

  • Address comments on this PR that start with 'DevinAI'.
  • Look at CI failures and help fix them

Note: I can only respond to comments from users who have write access to this repository.

⚙️ Control Options:

  • Disable automatic comment and CI monitoring

Copy link
Contributor

coderabbitai bot commented Jul 25, 2025

Important

Review skipped

Draft detected.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

✨ Finishing Touches
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch devin/migrate-org-onboarding-logo-to-avatars-1753463668

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai generate unit tests to generate unit tests for this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@github-actions github-actions bot added the ❗️ migrations contains migration files label Jul 25, 2025
@keithwillcode keithwillcode added core area: core, team members only foundation labels Jul 25, 2025
- Add comprehensive test suite for logo migration functionality
- Test base64 logo processing using uploadLogo and avatar system
- Verify preference for logoUrl over legacy logo field
- Test handling of non-base64 data and null values
- Ensure backward compatibility with deprecated logo field
- Fix OrganizationRepository to properly save logoUrl field
- Move logo processing after organization creation for correct teamId

Co-Authored-By: zomars@cal.com <zomars@me.com>
Copy link

vercel bot commented Jul 25, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

2 Skipped Deployments
Name Status Preview Comments Updated (UTC)
cal ⬜️ Ignored (Inspect) Jul 25, 2025 6:31pm
cal-eu ⬜️ Ignored (Inspect) Jul 25, 2025 6:31pm

- Add logoUrl: null to test expectations after schema migration
- Handle invitedMembers: undefined in admin override tests
- Ensure tests match actual OrganizationPaymentService behavior

Co-Authored-By: zomars@cal.com <zomars@me.com>
Copy link
Contributor

github-actions bot commented Aug 9, 2025

This PR is being marked as stale due to inactivity.

@github-actions github-actions bot added the Stale label Aug 9, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
core area: core, team members only foundation ❗️ migrations contains migration files Stale
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants