tangled.org / core
Monorepo for Tangled tangled.org
fork atom

appview: allows a default knot to be configured #991

open opened by willdot.net targeting master from willdot.net/tangled-fork: default-knot

This follows on from the work carried out in #836

I've added a select box in the Knots settings page which pulls in the users knots and also adds in knot1.tangled.sh. When the user selects one of these options, it will save to their profile in the database. NOTE: I haven't yet implemented adding that to the AT record because I'm not sure on how the lexicon setup works yet!

Then when users go to create a new repo / fork, if there is a value in their profile for the default knot, then that will pre select the knot to use for the new repo / fork.

This is a duplicate of https://tangled.org/tangled.org/core/pulls/858/ which had to be closed because there were merge conflicts which couldn't be resolved due to the origin fork being deleted 🙈

Labels

None yet.

assignee

None yet.

Participants 2
AT URI
at://did:plc:dadhhalkfcq3gucaq25hjqon/sh.tangled.repo.pull/3mcrzfonnxs22
+154 -7
Diff #9
+8
appview/db/db.go
··· 596 596 foreign key (webhook_id) references webhooks(id) on delete cascade 597 597 ); 598 598 599 + create table if not exists knot_preferences ( 600 + id integer primary key autoincrement, 601 + user_did text not null unique, 602 + default_knot text, 603 + 604 + foreign key (user_did, default_knot) references registrations(did, domain) on delete cascade 605 + ); 606 + 599 607 create table if not exists migrations ( 600 608 id integer primary key autoincrement, 601 609 name text unique
+35
appview/db/preferences.go
··· 50 50 51 51 return nil 52 52 } 53 + 54 + func GetKnotPreference(e Execer, did string) (*models.KnotPreference, error) { 55 + var knotPreference models.KnotPreference 56 + 57 + err := e.QueryRow( 58 + `select id, user_did, default_knot from knot_preferences where user_did = ?`, 59 + did, 60 + ).Scan(&knotPreference.ID, &knotPreference.Did, &knotPreference.DefaultKnot) 61 + if err == sql.ErrNoRows { 62 + return nil, nil 63 + } 64 + 65 + if err != nil { 66 + return nil, err 67 + } 68 + 69 + return &knotPreference, nil 70 + } 71 + 72 + func UpsertKnotPreference(e Execer, did, defaultKnot string) error { 73 + _, err := e.Exec( 74 + `insert or replace into knot_preferences ( 75 + user_did, 76 + default_knot 77 + ) 78 + values (?, ?)`, 79 + did, 80 + defaultKnot, 81 + ) 82 + if err != nil { 83 + return err 84 + } 85 + 86 + return nil 87 + }
+20 -2
appview/knots/knots.go
··· 68 68 return 69 69 } 70 70 71 + availableKnots, err := k.Enforcer.GetKnotsForUser(user.Did()) 72 + if err != nil { 73 + k.Logger.Error("failed to fetch available knots for user", "err", err) 74 + w.WriteHeader(http.StatusInternalServerError) 75 + return 76 + } 77 + 78 + defaultKnot := "" 79 + knotPrefence, err := db.GetKnotPreference(k.Db, user.Did()) 80 + if err != nil { 81 + k.Logger.Warn("gettings users knot preferences", "error", err) 82 + } 83 + if knotPrefence != nil { 84 + defaultKnot = knotPrefence.DefaultKnot 85 + } 86 + 71 87 k.Pages.Knots(w, pages.KnotsParams{ 72 - LoggedInUser: user, 73 - Registrations: registrations, 88 + LoggedInUser: user, 89 + Registrations: registrations, 90 + AvailableKnots: availableKnots, 91 + DefaultKnot: defaultKnot, 74 92 }) 75 93 } 76 94
+6
appview/models/preferences.go
··· 6 6 HideMine bool 7 7 HideOthers bool 8 8 } 9 + 10 + type KnotPreference struct { 11 + ID int 12 + Did string 13 + DefaultKnot string 14 + }
+7 -3
appview/pages/pages.go
··· 440 440 } 441 441 442 442 type KnotsParams struct { 443 - LoggedInUser *oauth.MultiAccountUser 444 - Registrations []models.Registration 445 - Tab string 443 + LoggedInUser *oauth.MultiAccountUser 444 + Registrations []models.Registration 445 + Tab string 446 + AvailableKnots []string 447 + DefaultKnot string 446 448 } 447 449 448 450 func (p *Pages) Knots(w io.Writer, params KnotsParams) error { ··· 506 508 type NewRepoParams struct { 507 509 LoggedInUser *oauth.MultiAccountUser 508 510 Knots []string 511 + DefaultKnot string 509 512 } 510 513 511 514 func (p *Pages) NewRepo(w io.Writer, params NewRepoParams) error { ··· 516 519 LoggedInUser *oauth.MultiAccountUser 517 520 Knots []string 518 521 RepoInfo repoinfo.RepoInfo 522 + DefaultKnot string 519 523 } 520 524 521 525 func (p *Pages) ForkRepo(w io.Writer, params ForkRepoParams) error {
+28
appview/pages/templates/knots/index.html
··· 31 31 <div class="flex flex-col gap-6"> 32 32 {{ block "list" . }} {{ end }} 33 33 {{ block "register" . }} {{ end }} 34 + {{ block "default-knot" . }} {{ end }} 34 35 </div> 35 36 </section> 36 37 {{ end }} ··· 62 63 </section> 63 64 {{ end }} 64 65 66 + {{ define "default-knot" }} 67 + <section class="rounded w-full flex flex-col gap-2"> 68 + <h2 class="text-sm font-bold py-2 uppercase dark:text-gray-300">default knot</h2> 69 + <form hx-post="/profile/default-knot" class="col-span-1 md:col-span-1 md:justify-self-end group flex gap-2 items-stretch"> 70 + <select 71 + id="default-knot" 72 + name="default-knot" 73 + required 74 + class="p-1 max-w-64 border border-gray-200 bg-white dark:bg-gray-800 dark:text-white dark:border-gray-700"> 75 + {{/* For some reason, we can't use an empty string in a <select> in all scenarios unless it is preceded by a disabled select?? No idea, could just be a Firefox thing? */}} 76 + <option value="[[none]]" class="py-1" {{ if not $.DefaultKnot }}selected{{ end }}> 77 + Choose a default knot 78 + </option> 79 + {{ range $.AvailableKnots }} 80 + <option value="{{ . }}" class="py-1" {{ if eq . $.DefaultKnot }}selected{{ end }}> 81 + {{ . }} 82 + </option> 83 + {{ end }} 84 + </select> 85 + <button class="btn flex gap-2 items-center" type="submit"> 86 + {{ i "check" "size-4" }} 87 + {{ i "loader-circle" "w-4 h-4 animate-spin hidden group-[.htmx-request]:inline" }} 88 + </button> 89 + </form> 90 + </section> 91 + {{ end }} 92 + 65 93 {{ define "register" }} 66 94 <section class="rounded w-full lg:w-fit flex flex-col gap-2"> 67 95 <h2 class="text-sm font-bold py-2 uppercase dark:text-gray-300">register a knot</h2>
+3 -1
appview/pages/templates/repo/fork.html
··· 25 25 value="{{ . }}" 26 26 class="mr-2" 27 27 id="domain-{{ . }}" 28 - {{if eq (len $.Knots) 1}}checked{{end}} 28 + {{if eq (len $.Knots) 1}}checked 29 + {{else if eq $.DefaultKnot . }}checked 30 + {{end}} 29 31 /> 30 32 <label for="domain-{{ . }}" class="dark:text-white">{{ . }}</label> 31 33 </div>
+3 -1
appview/pages/templates/repo/new.html
··· 156 156 class="mr-2" 157 157 id="domain-{{ . }}" 158 158 required 159 - {{if eq (len $.Knots) 1}}checked{{end}} 159 + {{if eq (len $.Knots) 1}}checked 160 + {{else if eq $.DefaultKnot . }}checked 161 + {{end}} 160 162 /> 161 163 <label for="domain-{{ . }}" class="dark:text-white lowercase">{{ . }}</label> 162 164 </div>
+10
appview/repo/repo.go
··· 1004 1004 return 1005 1005 } 1006 1006 1007 + defaultKnot := "" 1008 + knotPrefence, err := db.GetKnotPreference(rp.db, user.Did()) 1009 + if err != nil { 1010 + rp.logger.Warn("gettings users knot preferences", "error", err) 1011 + } 1012 + if knotPrefence != nil { 1013 + defaultKnot = knotPrefence.DefaultKnot 1014 + } 1015 + 1007 1016 rp.pages.ForkRepo(w, pages.ForkRepoParams{ 1008 1017 LoggedInUser: user, 1009 1018 Knots: knots, 1010 1019 RepoInfo: rp.repoResolver.GetRepoInfo(r, user), 1020 + DefaultKnot: defaultKnot, 1011 1021 }) 1012 1022 1013 1023 case http.MethodPost:
+23
appview/state/profile.go
··· 649 649 s.updateProfile(profile, w, r) 650 650 } 651 651 652 + func (s *State) UpdateDefaultKnotPreference(w http.ResponseWriter, r *http.Request) { 653 + err := r.ParseForm() 654 + if err != nil { 655 + log.Println("invalid preference update form", err) 656 + return 657 + } 658 + user := s.oauth.GetMultiAccountUser(r) 659 + 660 + defaultKnot := r.Form.Get("default-knot") 661 + 662 + if defaultKnot == "[[none]]" { // see pages/templates/knots/index.html for more info on why we use this value 663 + defaultKnot = "" 664 + } 665 + 666 + err = db.UpsertKnotPreference(s.db, user.Did(), defaultKnot) 667 + if err != nil { 668 + log.Println("failed to update default knot preference", err) 669 + return 670 + } 671 + 672 + s.pages.HxRefresh(w) 673 + } 674 + 652 675 func (s *State) updateProfile(profile *models.Profile, w http.ResponseWriter, r *http.Request) { 653 676 user := s.oauth.GetMultiAccountUser(r) 654 677 tx, err := s.db.BeginTx(r.Context(), nil)
+1
appview/state/router.go
··· 168 168 r.Post("/avatar", s.UploadProfileAvatar) 169 169 r.Delete("/avatar", s.RemoveProfileAvatar) 170 170 r.Post("/punchcard", s.UpdateProfilePunchcardSetting) 171 + r.Post("/default-knot", s.UpdateDefaultKnotPreference) 171 172 }) 172 173 173 174 r.Mount("/settings", s.SettingsRouter())
+10
appview/state/state.go
··· 430 430 return 431 431 } 432 432 433 + defaultKnot := "" 434 + knotPrefence, err := db.GetKnotPreference(s.db, user.Did()) 435 + if err != nil { 436 + s.logger.Warn("gettings users knot preferences", "error", err) 437 + } 438 + if knotPrefence != nil { 439 + defaultKnot = knotPrefence.DefaultKnot 440 + } 441 + 433 442 s.pages.NewRepo(w, pages.NewRepoParams{ 434 443 LoggedInUser: user, 435 444 Knots: knots, 445 + DefaultKnot: defaultKnot, 436 446 }) 437 447 438 448 case http.MethodPost:

History

14 rounds 18 comments
sign up or login to add to the discussion
willdot.net submitted #13
diff interdiff
1 commit
expand
7999c8b2
appview: allows a default knot to be configured
no conflicts, ready to merge
expand 1 comment
willdot.net

@oppi.li any chance of a look at this again. I remembered this the other day when I created a new repo and had to manually select a Knot 🙈

willdot.net submitted #12
diff interdiff
1 commit
expand
68d9f0b6
appview: allows a default knot to be configured
expand 0 comments
willdot.net submitted #11
diff interdiff
1 commit
expand
5618be13
appview: allows a default knot to be configured
expand 0 comments
willdot.net submitted #10
diff interdiff
1 commit
expand
080125f9
appview: allows a default knot to be configured
expand 0 comments
willdot.net submitted #9
interdiff
1 commit
expand
c81b80da
appview: allows a default knot to be configured
expand 0 comments
willdot.net submitted #8
diff interdiff
1 commit
expand
ab57bdfc
appview: allow default knot to be saved as a preference and then used when creating a new repo
expand 0 comments
willdot.net submitted #7
diff interdiff
1 commit
expand
361559b7
appview: allow default knot to be saved as a preference and then used when creating a new repo
expand 8 comments
oppi.li

sorry for the late review! on the whole the code looks good. my only nit is with the model: we are storing the default knot as a string, but knot deletions can make this go out of sync. i think an FK relationship with the knot registrations table could fix this. we just unset defaults when a knot is deleted.

willdot.net

That's a super valid point, didn't think of that!

I'll add a default value to empty string on the default_knot field, a foreign key constraint to the registrations table domain field since it's a unique field, and then ON DELETE SET DEFAULT so that if the knot gets deleted, the knot preference gets set to an empty string.

willdot.net

That's a super valid point, didn't think of that!

I'll add a default value to empty string on the default_knot field, a foreign key constraint to the registrations table domain field since it's a unique field, and then ON DELETE SET DEFAULT so that if the knot gets deleted, the knot preference gets set to an empty string.

oppi.li

sure yeah that would work, we could cascade as well. either is fine i think.

willdot.net

I thought about cascade but my understanding is that the knot_preference row for the user would be deleted if the knot is deleted.

If this is a preferences row for a user, there has potential for other things to be stored in that row which we may not want deleted on knot deletion.

oppi.li

makes sense!

willdot.net

Ok I've made these changes but I have had to do the cascade action on delete.

The reason for this is that the registrations table has a unique constraint on both the did and domain fields. The did is the user that is adding the registration, so that should be the user that is also creating the knot_preference row (which is also unique) and it can't be null.

Using the on delete set default therefor wouldn't work because the user_did field on the knot_preference can't be null.

So cascade is the only option.

willdot.net

Although now I'm starting to doubt the design of the table. Perhaps it should be just for default knot preferences and thus named as that?

willdot.net submitted #6
diff interdiff
1 commit
expand
10fdc2cf
appview: allow default knot to be saved as a preference and then used when creating a new repo
expand 0 comments
willdot.net submitted #5
diff interdiff
1 commit
expand
8f3e1061
appview: allow default knot to be saved as a preference and then used when creating a new repo
expand 0 comments
willdot.net submitted #4
diff interdiff
1 commit
expand
64142e65
appview: allows a default knot to be selected from knots available to the user
expand 5 comments
willdot.net

@oppi.li While attempting to implement something else related to profiles, I've noticed that UpsertProfile(...) herehttps://tangled.org/tangled.org/core/blob/master/appview/db/profile.go#L133 also gets called as part of a JS ingester here https://tangled.org/tangled.org/core/blob/master/appview/ingester.go#L352 which means the DefaultKnot field will be overwritten with an empty string when a profile event is ingested. Am I understanding that correctly?

So instead I should probably not use the UpsertProfile(...) but use a smaller scoped function that just sets the Default Knot field?

oppi.li

ah that is correct, the default knot will be overwritten by that call. i suppose that is one of the drawbacks of overloading models.Profile! instead of cloning UpsertProfile to add this as an exception, perhaps this is an indication that we need to avoid using the profile table/model for this. what do you think about creating a preferences table for stuff like this? we already have notification_preferences, we could do something similar for knots.

i see you have a PR open for punchcard work as well, which would fit quite well in a punchcard_preferences table.

willdot.net

Yh I'm 100% down for using that approach. While I was implementing the punchcard PR I had this nagging feeling in me that this and other things belonged in some sort of separate "preferences" table so splitting them out into things like knot_preferences or punchcard_preferences is the right answer for me.

I'll redo that for this PR and then do the same of the other PR and hopefully it will prevent the merge conflicts I was dreading 🙈

oppi.li

yeah! knot_preferences and punchcard_preferences seems okay for now. thanks for keeping at this by the way, and sorry for the slow review cycle!

willdot.net

No worries! I don't expect immediate reviews 😁

I've refactored to use a new knot_preferences table for this PR. I had some merge conflicts with master though, so rebased that although took me a couple attempts to get everything nice and neat, hence so many rounds 🙈

willdot.net submitted #3
diff interdiff
2 commits
expand
9a142873
appview: allows a default knot to be configured
7000e5e6
appview: allows a default knot to be selected from knots available to the user
expand 0 comments
willdot.net submitted #2
diff interdiff
1 commit
expand
9a142873
appview: allows a default knot to be configured
expand 2 comments
oppi.li

the code itself works pretty nicely now. so i've noticed a couple issues (apologies for not looking more closely earlier!):

  • the default-knot selector only iterates over knots that the user is an admin of, whereas they should be able to choose any knot that they are a member of as the default. you can use s.enforcer.GetKnotsForUser(...) to get a list of knots that a user has access to
  • the HTML change adds knot1.tangled.sh as an explicit case, this is not necessary if the above is implemented
  • the HTML template currently triggers a request when the select changes, could we make this more like how the spindle selector works? a form with a button to submit.
willdot.net

I was looking for ages trying to find somewhere that did something similar. I don't use spindles so never saw that 🙈 A much better approach.

Also good shout on the knots for a user. Reading the code now, I understand what the registrations are now.

Anyhow, I've updated the PR and squashed everything so it should be good to test now.

Please note, that I have yet to figure out how to get multiple Knots running locally, and since I don't get knot1.tangled.sh locally I had to hard code some things in to test it worked, which is less than ideal.

willdot.net submitted #1
diff interdiff
1 commit
expand
d48b01e5
appview: allows a default knot to be configured
expand 0 comments
willdot.net submitted #0
diff
1 commit
expand
5ffb8261
appview: allows a default knot to be configured
expand 2 comments
oppi.li

i get this error at runtime:

2026/01/20 04:58:12 profile err 5 values for 6 columns
2026/01/20 04:58:12 failed to update profile 5 values for 6 columns

this sql query is incorrect:

		`insert or replace into profile (
			did,
			description,
			include_bluesky,
			location,
			pronouns,
			default_knot
		)
		values (?, ?, ?, ?, ?)`,

there should be 6 ? placeholders!

willdot.net

Ah crap, someone needs to create a lint tool that detects that 🤦‍♂️

Fixed.