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
+160 -7
Diff #7
unified split
+6
appview/db/db.go
··· 568 568 unique (from_at, to_at) 569 569 ); 570 570 571 + create table if not exists knot_preferences ( 572 + id integer primary key autoincrement, 573 + user_did text not null unique, 574 + default_knot text 575 + ); 576 + 571 577 create table if not exists migrations ( 572 578 id integer primary key autoincrement, 573 579 name text unique
+42
appview/db/preferences.go
··· 1 + package db 2 + 3 + import ( 4 + "database/sql" 5 + 6 + "tangled.org/core/appview/models" 7 + ) 8 + 9 + func GetKnotPreference(e Execer, did string) (*models.KnotPreference, error) { 10 + var knotPreference models.KnotPreference 11 + 12 + err := e.QueryRow( 13 + `select id, user_did, default_knot from knot_preferences where user_did = ?`, 14 + did, 15 + ).Scan(&knotPreference.ID, &knotPreference.Did, &knotPreference.DefaultKnot) 16 + if err == sql.ErrNoRows { 17 + return nil, nil 18 + } 19 + 20 + if err != nil { 21 + return nil, err 22 + } 23 + 24 + return &knotPreference, nil 25 + } 26 + 27 + func UpsertKnotPreference(e Execer, did, defaultKnot string) error { 28 + _, err := e.Exec( 29 + `insert or replace into knot_preferences ( 30 + user_did, 31 + default_knot 32 + ) 33 + values (?, ?)`, 34 + did, 35 + defaultKnot, 36 + ) 37 + if err != nil { 38 + return err 39 + } 40 + 41 + return nil 42 + }
+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
+7
appview/models/preferences.go
··· 1 + package models 2 + 3 + type KnotPreference struct { 4 + ID int 5 + Did string 6 + DefaultKnot string 7 + }
+7 -3
appview/pages/pages.go
··· 420 420 } 421 421 422 422 type KnotsParams struct { 423 - LoggedInUser *oauth.MultiAccountUser 424 - Registrations []models.Registration 425 - Tab string 423 + LoggedInUser *oauth.MultiAccountUser 424 + Registrations []models.Registration 425 + Tab string 426 + AvailableKnots []string 427 + DefaultKnot string 426 428 } 427 429 428 430 func (p *Pages) Knots(w io.Writer, params KnotsParams) error { ··· 486 488 type NewRepoParams struct { 487 489 LoggedInUser *oauth.MultiAccountUser 488 490 Knots []string 491 + DefaultKnot string 489 492 } 490 493 491 494 func (p *Pages) NewRepo(w io.Writer, params NewRepoParams) error { ··· 496 499 LoggedInUser *oauth.MultiAccountUser 497 500 Knots []string 498 501 RepoInfo repoinfo.RepoInfo 502 + DefaultKnot string 499 503 } 500 504 501 505 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
··· 155 155 class="mr-2" 156 156 id="domain-{{ . }}" 157 157 required 158 - {{if eq (len $.Knots) 1}}checked{{end}} 158 + {{if eq (len $.Knots) 1}}checked 159 + {{else if eq $.DefaultKnot . }}checked 160 + {{end}} 159 161 /> 160 162 <label for="domain-{{ . }}" class="dark:text-white lowercase">{{ . }}</label> 161 163 </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
··· 605 605 s.updateProfile(profile, w, r) 606 606 } 607 607 608 + func (s *State) UpdateDefaultKnotPreference(w http.ResponseWriter, r *http.Request) { 609 + err := r.ParseForm() 610 + if err != nil { 611 + log.Println("invalid preference update form", err) 612 + return 613 + } 614 + user := s.oauth.GetMultiAccountUser(r) 615 + 616 + defaultKnot := r.Form.Get("default-knot") 617 + 618 + if defaultKnot == "[[none]]" { // see pages/templates/knots/index.html for more info on why we use this value 619 + defaultKnot = "" 620 + } 621 + 622 + err = db.UpsertKnotPreference(s.db, user.Did(), defaultKnot) 623 + if err != nil { 624 + log.Println("failed to update default knot preference", err) 625 + return 626 + } 627 + 628 + s.pages.HxRefresh(w) 629 + } 630 + 608 631 func (s *State) updateProfile(profile *models.Profile, w http.ResponseWriter, r *http.Request) { 609 632 user := s.oauth.GetMultiAccountUser(r) 610 633 tx, err := s.db.BeginTx(r.Context(), nil)
+1
appview/state/router.go
··· 167 167 r.Post("/pins", s.UpdateProfilePins) 168 168 r.Post("/avatar", s.UploadProfileAvatar) 169 169 r.Delete("/avatar", s.RemoveProfileAvatar) 170 + r.Post("/default-knot", s.UpdateDefaultKnotPreference) 170 171 }) 171 172 172 173 r.Mount("/settings", s.SettingsRouter())
+10
appview/state/state.go
··· 418 418 return 419 419 } 420 420 421 + defaultKnot := "" 422 + knotPrefence, err := db.GetKnotPreference(s.db, user.Did()) 423 + if err != nil { 424 + s.logger.Warn("gettings users knot preferences", "error", err) 425 + } 426 + if knotPrefence != nil { 427 + defaultKnot = knotPrefence.DefaultKnot 428 + } 429 + 421 430 s.pages.NewRepo(w, pages.NewRepoParams{ 422 431 LoggedInUser: user, 423 432 Knots: knots, 433 + DefaultKnot: defaultKnot, 424 434 }) 425 435 426 436 case http.MethodPost:

History

8 rounds 9 comments
sign up or login to add to the discussion
willdot.net submitted #7
interdiff
1 commit
expand
361559b7
appview: allow default knot to be saved as a preference and then used when creating a new repo
no conflicts, ready to merge
expand 0 comments
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.