appsmith icon indicating copy to clipboard operation
appsmith copied to clipboard

feat: generate building block from user data POC

Open jacquesikot opened this issue 1 year ago • 17 comments

Description

This is a Proof of Concept(POC) to allow users generate existing building with their own data. More details are covered in this notion doc.

PR fixes following issue(s)

Fixes # (issue number)

Media

Type of change

Please delete options that are not relevant.

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Chore (housekeeping or task changes that don't impact user perception)
  • This change requires a documentation update

Testing

How Has This Been Tested?

Please describe the tests that you ran to verify your changes. Also list any relevant details for your test configuration. Delete anything that is not relevant

  • [ ] Manual
  • [ ] JUnit
  • [ ] Jest
  • [ ] Cypress

Test Plan

Add Testsmith test cases links that relate to this PR

Issues raised during DP testing

Link issues raised during DP testing for better visiblity and tracking (copy link from comments dropped on this PR)

Checklist:

Dev activity

  • [ ] My code follows the style guidelines of this project
  • [ ] I have performed a self-review of my own code
  • [ ] I have commented my code, particularly in hard-to-understand areas
  • [ ] I have made corresponding changes to the documentation
  • [ ] My changes generate no new warnings
  • [ ] I have added tests that prove my fix is effective or that my feature works
  • [ ] New and existing unit tests pass locally with my changes
  • [ ] PR is being merged under a feature flag

QA activity:

  • [ ] Speedbreak features have been covered
  • [ ] Test plan covers all impacted features and areas of interest
  • [ ] Test plan has been peer reviewed by project stakeholders and other QA members
  • [ ] Manually tested functionality on DP
  • [ ] We had an implementation alignment call with stakeholders post QA Round 2
  • [ ] Cypress test cases have been added and approved by SDET/manual QA
  • [ ] Added Test Plan Approved label after Cypress tests were reviewed
  • [ ] Added Test Plan Approved label after JUnit tests were reviewed

Summary by CodeRabbit

  • New Features
    • Introduced the capability to create building blocks directly from a data source table, enhancing the app development process.
    • Added new constants and actions to support the generation of building blocks from data starter apps.
  • Enhancements
    • Updated the Datasource View to include a new button for generating building blocks, improving user interaction and functionality.
  • Refactor
    • Reorganized imports and updated sagas to support new building block generation functionality.

jacquesikot avatar Jan 30 '24 08:01 jacquesikot

Walkthrough

The update introduces a new feature allowing the creation of building blocks directly from a data source table. This involves adding a new action type and function to dispatch this action, defining constants related to building blocks, and updating the UI to include a button for triggering this process. Additionally, the data source entity is enhanced with an optional property, and the saga layer is updated to handle the new action, streamlining the generation of building blocks from data starter apps.

Changes

File Path Change Summary
.../actions/templateActions.ts Added generateBuildingBlockFromDsTable function.
.../constants/ReduxActionConstants.tsx Introduced GENERATE_BUILDING_BLOCK_FROM_DS_TABLE_INIT action type.
.../constants/TemplatesConstants.tsx Added constants for building block generation.
.../entities/Datasource/index.ts Added isAutogenerated property to DatasourceColumns.
.../pages/Editor/DatasourceInfo/DatasourceViewModeSchema.tsx Updated with functionality to generate building blocks and UI changes.
.../sagas/TemplatesSagas.ts Modified and added sagas for building block generation.

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

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>.
    • Generate unit-tests for this file.
  • 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 generate unit tests for this file.
    • @coderabbitai modularize this function.
  • 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 generate interesting stats about this repository from git and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit tests.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • The JSON schema for the configuration file is available here.
  • 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/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

coderabbitai[bot] avatar Jan 30 '24 08:01 coderabbitai[bot]

@rahulbarwal Code quality changes will be made later today, this is just to get the initial dp going for stand up today.

jacquesikot avatar Jan 30 '24 08:01 jacquesikot

/build-deploy-preview

jacquesikot avatar Jan 30 '24 08:01 jacquesikot

Deploying Your Preview: https://github.com/appsmithorg/appsmith/actions/runs/7708584084. Workflow: On demand build Docker image and deploy preview. skip-tests: . env: . PR: 30740. recreate: .

github-actions[bot] avatar Jan 30 '24 08:01 github-actions[bot]

/build-deploy-preview

jacquesikot avatar Jan 30 '24 09:01 jacquesikot

Deploying Your Preview: https://github.com/appsmithorg/appsmith/actions/runs/7709336726. Workflow: On demand build Docker image and deploy preview. skip-tests: . env: . PR: 30740. recreate: .

github-actions[bot] avatar Jan 30 '24 09:01 github-actions[bot]

Deploy-Preview-URL: https://ce-30740.dp.appsmith.com

github-actions[bot] avatar Jan 30 '24 10:01 github-actions[bot]

/build-deploy-preview

jacquesikot avatar Jan 31 '24 09:01 jacquesikot

Deploying Your Preview: https://github.com/appsmithorg/appsmith/actions/runs/7723815222. Workflow: On demand build Docker image and deploy preview. skip-tests: . env: . PR: 30740. recreate: .

github-actions[bot] avatar Jan 31 '24 09:01 github-actions[bot]

Deploy-Preview-URL: https://ce-30740.dp.appsmith.com

github-actions[bot] avatar Jan 31 '24 09:01 github-actions[bot]

/build-deploy-preview

jacquesikot avatar Jan 31 '24 09:01 jacquesikot

Deploying Your Preview: https://github.com/appsmithorg/appsmith/actions/runs/7724208256. Workflow: On demand build Docker image and deploy preview. skip-tests: . env: . PR: 30740. recreate: .

github-actions[bot] avatar Jan 31 '24 09:01 github-actions[bot]

Deploy-Preview-URL: https://ce-30740.dp.appsmith.com

github-actions[bot] avatar Jan 31 '24 10:01 github-actions[bot]

/build-deploy-preview

jacquesikot avatar Feb 01 '24 09:02 jacquesikot

Deploying Your Preview: https://github.com/appsmithorg/appsmith/actions/runs/7739091103. Workflow: On demand build Docker image and deploy preview. skip-tests: . env: . PR: 30740. recreate: .

github-actions[bot] avatar Feb 01 '24 09:02 github-actions[bot]

Deploy-Preview-URL: https://ce-30740.dp.appsmith.com

github-actions[bot] avatar Feb 01 '24 09:02 github-actions[bot]

This PR has not seen activitiy for a while. It will be closed in 7 days unless further activity is detected.

github-actions[bot] avatar Feb 14 '24 16:02 github-actions[bot]

This PR has been closed because of inactivity.

github-actions[bot] avatar Mar 01 '24 16:03 github-actions[bot]