Get file extension and realm info by tintinthong · Pull Request #656 · cardstack/boxel

tintinthong · 2023-09-19T11:21:28Z

This PR handles getting of file extension AND getting of realm url to display at an arbitrary depth of the file types

Screen.Recording.2023-09-19.at.7.48.51.PM.mov

Now u can see that drafts and base realm exist side by side because its loaded from the type

I actually wanted to move stuff into the adoption chain RESOURCE. But there is a reactivity thing that when I call .type it becomes an infinite loop.

github-actions · 2023-09-19T11:26:58Z

Test Results

390 tests ±0 383 ✔️ ±0 5m 7s ⏱️ - 1m 45s
    1 suites ±0     7 💤 ±0
    1 files ±0     0 ❌ ±0

Results for commit ffb2ace. ± Comparison against base commit 183c8d5.

♻️ This comment has been updated with latest results.

tintinthong · 2023-09-20T04:41:19Z

After pairing yesterday, I was thinking deeper about this adoption chain resource and I have a few thoughts.

Name Changes. adoptionChainResource-> adoptionChainManager. I am open to naming suggestion.
Why I am keeping it. I have decided to keep it because we still need to coordinate the selection of cards within a file. This resource should: 1. handle the selection of the resource card type. schema editor shud just look to it and ask for the selected card type. 2. handle the loading of the card type. That hide the complexity in this resource and cleanup accordingly. This also goes with my understanding of design.
Pairing notes. There was a suggestion to treat this more simply to remove the adoption resource and move any selection logic into code mode. Which was good for simplifying the thought process but I think there is purpose for this resource -- particularly for storing selection state and cleaning it up. Also, with the pattern of 2 resources interacting with each other. I think this adoptionChainManager has no business in looking into a resource it is forwarding; I think this was a mistake in even thinking that. It will never look into cardType. The component decides if it wants to render the card type it receives.
What the Schema editor should do. The schema editor should just consume a get method -- right now its selectedCardType -- the first module export. In loadInheritanceChain the schema editor should have the returned resource at hand BUT it is still desired that it handles any loading state of the card-type by itself. This will be beneficial so handling any undefined state from the module resource will be abstracted away
Future work. The elephant in the room is what about variables and non-cards or fields. This would be a great place to store that coordination logic. I don't think it would be in the same cardType variable but it would in this resource. I think we need to make a good example that exemplifies the entire adoption chain

tintinthong · 2023-09-20T07:18:01Z

Screen.Recording.2023-09-20.at.3.15.08.PM.mov

Here is an updated screeen recording. Its a mock out of the new design. It makes a lot of better sense now. The resource I created is motivated by this design.

As you can see there is a selection highlight for the export that is selected.

I will incorporate a fuller design in another pr

tintinthong · 2023-09-20T07:20:25Z

Ok suggested new names

card-inheritance-panel -> module-inspector
adoption-chain-resource -> module-inspector-resource

tintinthong · 2023-09-20T14:01:58Z

belurgh fixing test

This reverts commit d1df438.

This reverts commit 20f00a6.

jurgenwerk · 2023-09-21T07:56:51Z

+        {{else}}
+          {{! Module case when visting, eg author.gts }}
+          <h3>In This File</h3>
+          {{#each this.elementsInFile as |el|}}


What is the difference between: elements, exports, definitions?

…ation

* register a redirect handler that returns redirected response * revert original change * fix * fix * fix * fix lint * fix * reposition * clean up & organise useage * fix file response.url not returning * fix url parts using pathname * arg to pass in realm * make realm url explicit to guard from the wrong use of handle

tintinthong · 2023-09-25T13:12:37Z

-  get adoptionChainTypes() {
-    return this.args.adoptionChain?.types;
+  get isCardInstance() {
+    return this.args.readyFile.url.endsWith('.json');


https://linear.app/cardstack/issue/CS-6053/stop-using-endswithjson-use-iscarddocument figured this is in a few places

FadhlanR

Looks good for me

jurgenwerk

Overall it looks good to me, comments for minor data passing simplifications.

jurgenwerk · 2023-09-25T14:05:22Z

-            <Label class='realm-name' data-test-definition-realm-name>in
-              {{this.realmName}}</Label>
-          </div>
+          {{#if @realmInfo}}


Consider using the RealmInfoProvider component (it was merged recently) so you don't have to pass the realm info into this component and you can get rid of the realmIcon getter

jurgenwerk · 2023-09-25T14:07:13Z

+    return this.load.isRunning;
+  }
+
+  get selectedElement() {


Would be great to paste this comment into a code comment here so it's clear what elements are https://github.com/cardstack/boxel/pull/656/files#r1332754268

tintinthong · 2023-09-25T14:09:19Z

This has a big renaming of Detail Panel . Will resolve it once its merged

habdelra · 2023-09-25T14:13:38Z

+}
+
+// forwards the card type resource (doesn't care about the card type resource)
+export class AdoptionChainManager extends Resource<AdoptionChainManagerArgs> {


I'm just trying to understand what this resource is actually doing--Manager is such a overloaded term. it's doesn't really help me to know what this thing does. Reading thru this i think what this resource is doing is trying to load all the cards specifically from a module? Maybe CardsFromModuleResource would be a better name for this? the isSelected is super confusing--that feels like it should be state of a component, not this resource. It's not clear how isSelected contributes to this resource other then adding unrelated state

Hmmmm i will say that this resource is in charge of managing the selection of elements (elements being exported cards, unexported cards, exported function, exported class). What I intended for this resource is to be consumed by both the detailPanel & the schemeEditor. Perhaps, at one point it will be consumed by monaco to get the location of the selection.

Would it be better to kill the resource and put things in code mode? Or Rename it?

that's super confusing to me--why do you need a resource to manage selection? that seems to be something that fits more naturally in a component not a resource. The component should use the resource to understand what all cards exist, and the selection state should live in the component since that is the class that contains the template that consumes the action for selection

the fact that you have an action on your resource is a tell that something is not right. the only way to change the state from the outside of the resource should be to pass it in as a thunk that triggers the resource to recompute when state in the thunk changes--not as an action

Actually the existence of cards wud be handled by the module resource. And i think it will continue that way. Ok in that case, i will remove this resource and put all logic in the root code mode component

Ive moved the select logic in code. And I also moved the array of cardTypes into code mode but still in a resource pattern. I think this is what we want tho. If it wasn't a resource, we would be recreating cardType everytime. So like you said we still need to load the cards. But I do agree that having it as adoption-chain-manager was confusing because it was not clear what it was doing

habdelra · 2023-09-25T14:17:28Z

+  @service declare cardService: CardService;
  declare loader: Loader;
  typeCache: Map<string, Type> = new Map();
+  moduleMetaCache: Map<string, { extension: string; realmInfo: RealmInfo }> =


perhaps the cache would actually do more if it lived in module scope--then all resources could share it. I would think this kind of information would change very rarely if ever. so probably a cache that could be shared by all resource instances would be more beneficial

https://linear.app/cardstack/issue/CS-6056/remove-modulemetacache-from-cardtype-place-cache-at-module-scope

Actually I think the realmInfoService can be used for this

get file extension and realm info

8185d22

tintinthong changed the title ~~get file extension and realm info~~ Get file extension and realm info Sep 19, 2023

tintinthong added 4 commits September 19, 2023 19:32

reinclude test

bce717f

put getRealmInfo in resource

33bb5eb

fix url bug

dd5d140

cache request

21defef

tintinthong requested review from habdelra and jurgenwerk September 19, 2023 13:27

tintinthong added 2 commits September 19, 2023 21:37

lint

f754c0f

Use adoption manager and use loading states

69e3ef5

tintinthong requested review from FadhlanR and lukemelia September 20, 2023 04:43

tintinthong added 3 commits September 20, 2023 14:28

add selection of card

97d686e

mock out some ui

2fb1bc3

Merge branch 'main' into add-extension-and-realm-info

916f4e9

fix lint

4a98b73

FadhlanR reviewed Sep 20, 2023

View reviewed changes

Comment thread packages/host/app/components/operator-mode/definition-container/base.gts Outdated

FadhlanR reviewed Sep 20, 2023

View reviewed changes

Comment thread packages/host/app/resources/adoption-chain-manager.ts Outdated

FadhlanR reviewed Sep 20, 2023

View reviewed changes

Comment thread packages/host/app/resources/adoption-chain-manager.ts Outdated

FadhlanR reviewed Sep 20, 2023

View reviewed changes

Comment thread packages/host/app/resources/adoption-chain-manager.ts Outdated

tintinthong added 6 commits September 20, 2023 18:21

refactor for better loading pattern and clearer role

9133227

Change selections to a single object

6efc1ef

might as well use a select button

a664938

add comment

7d32901

fix loading

f8a2140

place realm info deeper in definition info

a1594a3

TODO test

d1df438

tintinthong added 3 commits September 20, 2023 22:08

wokraround 4 redirect in host test

edd0e60

Revert "TODO test"

346767f

This reverts commit d1df438.

Revert "TODO for test"

cc90d68

This reverts commit 20f00a6.

jurgenwerk reviewed Sep 21, 2023

View reviewed changes

tintinthong added 3 commits September 22, 2023 22:29

fix due to card no longer being resource. TODO: solve .json identific…

aa1e1fb

…ation

Merge branch 'main' into add-extension-and-realm-info

60365c7

tintinthong requested review from backspace, burieberry and jurgenwerk September 25, 2023 13:03

use pathname

e6ef76e

tintinthong commented Sep 25, 2023

View reviewed changes

FadhlanR approved these changes Sep 25, 2023

View reviewed changes

habdelra reviewed Sep 25, 2023

View reviewed changes

Comment thread packages/host/app/resources/adoption-chain-manager.ts Outdated

habdelra reviewed Sep 25, 2023

View reviewed changes

Comment thread packages/host/app/resources/adoption-chain-manager.ts Outdated

jurgenwerk approved these changes Sep 25, 2023

View reviewed changes

habdelra reviewed Sep 25, 2023

View reviewed changes

tintinthong added 5 commits September 26, 2023 09:43

Merge branch 'main' into add-extension-and-realm-info

b6e7f77

move everything to code mode

3debe8e

Fix lint

c9309bd

Fix linting

2c3b147

fix info service to get card source accept header

ffb2ace

tintinthong merged commit e6318bc into main Sep 26, 2023

delete-merged-branch Bot deleted the add-extension-and-realm-info branch September 26, 2023 08:56

This was referenced Sep 26, 2023

use realmInfo provider in detail panel #679

Merged

Move Module Cache outside of resource #696

Merged

Uh oh!

Conversation

tintinthong commented Sep 19, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions Bot commented Sep 19, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Test Results

Uh oh!

tintinthong commented Sep 20, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

tintinthong commented Sep 20, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

tintinthong commented Sep 20, 2023

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

tintinthong commented Sep 20, 2023

Uh oh!

Uh oh!

jurgenwerk Sep 21, 2023

Choose a reason for hiding this comment

Uh oh!

tintinthong Sep 25, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

FadhlanR left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

jurgenwerk left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

jurgenwerk Sep 25, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jurgenwerk Sep 25, 2023

Choose a reason for hiding this comment

Uh oh!

tintinthong commented Sep 25, 2023

Uh oh!

habdelra Sep 25, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

tintinthong Sep 25, 2023

Choose a reason for hiding this comment

Uh oh!

habdelra Sep 25, 2023

Choose a reason for hiding this comment

Uh oh!

habdelra Sep 25, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

tintinthong Sep 25, 2023

Choose a reason for hiding this comment

Uh oh!

tintinthong Sep 26, 2023

Choose a reason for hiding this comment

Uh oh!

habdelra Sep 25, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

tintinthong Sep 26, 2023

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

tintinthong commented Sep 19, 2023 •

edited

Loading

github-actions Bot commented Sep 19, 2023 •

edited

Loading

tintinthong commented Sep 20, 2023 •

edited

Loading

tintinthong commented Sep 20, 2023 •

edited

Loading

tintinthong Sep 25, 2023 •

edited

Loading

jurgenwerk Sep 25, 2023 •

edited

Loading

habdelra Sep 25, 2023 •

edited

Loading

habdelra Sep 25, 2023 •

edited

Loading

habdelra Sep 25, 2023 •

edited

Loading