Entity templates #193
Merged
Entity templates #193
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
🦋 Changeset detectedLatest commit: 692e6db The changes in this PR will be included in the next version bump. This PR includes changesets to release 6 packages
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
github-actions
bot
added
the
maintainer
dmno
@dmno/configraph
@dmno/remix-integration
@dmno/vite-integration
@dmno/cloudflare-platform
@dmno/1password-plugin
@dmno/encrypted-vault-plugin
commit: |
theoephraim
commented
Jan 13, 2025
|
|
||
| readonly graphRoot: Configraph; | ||
| readonly templateRootEntity?: ConfigraphEntity<EntityMetadata, NodeMetadata>; | ||
|
|
||
| constructor( |
There was a problem hiding this comment.
This is where the significant changes are.
we now follow up a chain of templates, applying the changes to config nodes from each, and adding/deleting/removing additional entities to the graph if applicable
theoephraim
commented
Jan 13, 2025
|
|
||
| // add graph edges based on "pick" | ||
| // we will not process individual items yet, but this will give us a DAG of entity dependencies | ||
| for (const entity of entitiesArray) { |
There was a problem hiding this comment.
no longer doing all these shenanigans with pick up front. instead we create the nodes normally, and then do a pass to re-connect picked nodes to their sources
theoephraim
commented
Jan 13, 2025
| import { templateContextAls } from './entity-template'; | ||
|
|
||
| // special new data type that will delegate calls back to the original "picked" data type | ||
| export class PickedDataType extends ConfigraphDataType { |
There was a problem hiding this comment.
pick is a little different than something like inject - which is just a resolver. Pick needs to set all of the data type properties, not just how it is resolved, so we need to be able to link to the source node.
While the line here between data types / config nodes / resolvers all gets a bit blurrier than I would like, I think the end result for users is fairly clean and intuitive.
Deploying dmno with
|
| Latest commit: |
692e6db
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://6d5e89db.dmno.pages.dev |
| Branch Preview URL: | https://entity-templates.dmno.pages.dev |
Making entity templates actually work invovled some larger changes, many of which were nice simplicications of other moving parts.
Templates can now be created and entities can extend them. Templates can create/update/remove multiple entities from the graph. IDs are all relative to the template while inside of it, and while this was difficult to implement, for end users it should just feel intuitive.
The big non-template change is that now pick is more unified with the rest of the system - reimplimented as a special kind of data type. Rather than being defined in a separate section we now use pick via extends - for example: `SOME_ITEM: { extends: pick('someEntityId', 'someNode')` and because of the shorthand format already available (ie `SOME_ITEM: 'string'`), this means `SOME_ITEM: pick()` will also work.
The pick args work like this:
- `ITEM: pick()` - defaults to picking from graph/template root, use same node path
- `ITEM: pick('entityId')` - specify entity by id, use same node path
- `ITEM: pick('entityId', 'somePath')` - specify both entity id and node path
While we lose the ability to pick multiple keys at once, these changes were driven by user feedback and are worthwhile.
theoephraim
force-pushed
the
entity-templates
branch
from
45cb39d to
a6f6659
Compare
theoephraim
force-pushed
the
entity-templates
branch
from
a6f6659 to
5bce745
Compare
theoephraim
force-pushed
the
entity-templates
branch
from
5bce745 to
c624c05
Compare
philmillman
approved these changes
Jan 15, 2025
Co-authored-by: Phil Miller <[email protected]>
theoephraim
force-pushed
the
entity-templates
branch
from
5fff14b to
692e6db
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This is a big update, driven by the goal of making entity templates work - which will be very important for deployment functionality.
Templates can now be created and entities can extend them. Templates can create/update/remove multiple entities from the graph. IDs are all relative to the template while inside of it, and while this was difficult to implement, for end users it should just feel intuitive. We wont see any user-facing DMNO changes just yet, but these will come next.
In the process, we also changed how "pick" works, to be more unified with the rest of the schema. Now it is reimplimented as a special kind of data type, and uses the existing data type chain for its settings. Rather than being defined in a separate section we now use pick via extends - for example:
SOME_ITEM: { extends: pick('someEntityId', 'someNode')and because of the shorthand format already available (ieSOME_ITEM: 'string'), this meansSOME_ITEM: pick()will also work.The pick args work like this:
ITEM: pick()- defaults to picking from graph/template root, use same node pathITEM: pick('entityId')- specify entity by id, use same node pathITEM: pick('entityId', 'somePath')- specify both entity id and node pathWhile we lose the ability to pick multiple keys at once, these changes were driven by user feedback and are worthwhile.
Additionally this removed some existing constraints around what is considered a cycle, and the system is now more permissive.